External competing offers now available in GET /offers

{
Represents a pagination result for the offers collection.
  items: [
The collection of offers related to the current pagination result.
    {
Offer aggregate data structure
      sellerId*: integer (int64)
Seller identifier
      sellerExternalReference: string
Seller external reference
      condition: string|enum
Product condition status
Example: New
Enum[9]: [LikeNew, VeryGoodState, GoodState, AverageState, Refurbished, New, RefurbishedLikeNew, RefurbishedVeryGoodState, RefurbishedCorrectState]
      salesChannelId*: string
Sales channel identifier = 4 first letters of the Marketplace + 2 first letters of the country code
      offerId: string
Offer technical identifier is made up of: SellerId_ProductId_ProductConditionId_SalesChannelId
      offerState: string|enum
Offer status
- `Active` - active state
- `Inactive` - Inactive state
Enum[2]: [Active, Inactive]
      salesChannelAcceptanceStatus: string|null|enum
Defines if the product has been accepted or no by the sales channel. Can be null if the product was not shown to the sales channel yet.
Enum[3]: [New, Accepted, Rejected]
      product: {
Product informations
        gtin: string
The product GTIN
        reference: string
Product identifier
      }
      integrationPrice: {
Price data structure integrated by the seller
        currencyCode: string
Currency code in ISO 4217 format. Supports:
- All currency codes with 3 letters like 'EUR' for Euro, 'USD' for US Dollar, 'JPY' for Japanese Yen, etc.
see https://en.wikipedia.org/wiki/ISO_4217
        originPrice: number (double)
Origin price value or stricked price
        price: number (double)
Price value integrated by the seller
        taxes: [
List of Taxes
          {
tax data structure
            code: string
tax code
            type: string|enum
tax type data structure
Enum[2]: [Rate, Amount]
            value: number (double)
tax value
          }
        ]
      }
      facialPrice: {
Price data structure
        currencyCode: string
Currency code in ISO 4217 format. Supports:
- All currency codes with 3 letters like 'EUR' for Euro, 'USD' for US Dollar, 'JPY' for Japanese Yen, etc.
see https://en.wikipedia.org/wiki/ISO_4217
        originPrice: number (double)
Origin price value or stricked price
        price: number (double)
Price value displayed by the market place
        taxes: [
List of Taxes
          {
tax data structure
            code: string
tax code
            type: string|enum
tax type data structure
Enum[2]: [Rate, Amount]
            value: number (double)
tax value
          }
        ]
      }
      isBestOffer: boolean|null
Is the offer the best one on this sales channel.
      bestOffer: object|null {
Price and delivery cost of the current best offer for this product on this sales channel. Can be null if no best offer defined yet.
        currencyCode: string
Currency code in ISO 4217 format. Supports:
- All currency codes with 3 letters like 'EUR' for Euro, 'USD' for US Dollar, 'JPY' for Japanese Yen, etc.
see https://en.wikipedia.org/wiki/ISO_4217
        deliveryCost: number (double)
Cheapest delivery cost of the current best offer
        price: number (double)
Price of the current best offer
      }
      deliveryOffers: [
        {
Offer delivery aggregate data structure
          deliveryModes: [
Delivery mode data structure
            {
              additionalCost: number (double)
Additional delivery cost
              code: string
Delivery mode code on Octopia
              cost: number (double)
Main delivery cost
              legacyDeliveryModeId: string|null
Legacy delivery mode
              maxDeliveryTime: integer
Maximum delivery time calculated in business days
              minDeliveryTime: integer
Minimum delivery time calculated in business days
            }
          ]
          isBestDelivery: boolean
Only the best delivery offers is used by the sale channel
          preparationTime: integer (int32)
Offer preparation time (Only for Seller Supply Mode)
          quantity: integer (int32)
Offer stock quantity
          supplyMode: string|enum
The identifies the logistic process used to ship the order item.
- `Seller` - marketplace mode
- `Fulfillment` - Fulfillment mode
- `Xdock` - XDock mode (DEPRECATED)
Enum[3]: [Seller, Fulfillment, Xdock]
        }
      ]
      createdAt: string (date-time)
Offer creation date
      updatedAt: string (date-time)
Last offer update date
      conversionDate: string (date-time)
Price conversion date
      comments: string
The comments on the offer.
      offerCompetition: {
The offer competition is the feature that allows an offer to automatically decrease its price when another offer is cheaper. Only if the minimum price allows it. If the conditions are met, the price of the offer will automatically decrease to 0,01 cents under the competitors offer in order to win the buy box.
        isActivated: boolean
The information on the activation of this feature. True if it is activated. False if it is not activated. If the feature has never been activated, the field does not appear.
        minimumPrice: number (double)
The value of the minimum price. If the activation is null, the fields will not be available
      }
      salesChannelFeedback: {
        isOnline: boolean|null
Indicates if the offer is published on the sales channel.
        displayedOfferPrice: number|null
Price value displayed on this sales channel.
        deliveryCost: number|null
The cheapest shipping cost for this offer.
        updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        bestOfferDetails: {
          isBestOffer: boolean|null
Indicates if the offer is the best one (buybox) on the sales channel.
          isBestOfferUpdatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
          bestOffer: {
            price: number|null
The price of the offer with the buybox, on the sales channel.
            deliveryCost: number|null
The shipping cost of the offer with the buybox, on the sales channel.
            updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
          }
        }
        productInformation: {
          productPageUrl: string|null
URL of the product page on the sales channel.
          productReviewsCount: integer|null
The number of reviews posted by customers for this product.
          productReviewsAverageRating: number|null
The average rating of the product reviews, rounded to one decimal place. While the rating scale is usually out of 5 (as is for Cdiscount), the exact scale may vary depending on the sales channel.
          totalOffersCount: integer|null
The number of published offers on the sales channel, for the product in the specified productCondition.
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        offlineReason: {
          reason: string|null
Reason why the offer is not published on the sales channel.
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        sellerGrade: {
          sellerRating: integer|null
The average rating of the seller, rounded to one decimal place. While the rating scale is usually out of 5 (as is for Cdiscount), the exact scale may vary depending on the sales channel.
          sellerReviewsCount: integer|null
The number of reviews posted by customers for the seller, on the sales channel.
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        offerQuality: {
          offerScore: string|null
The quality score assigned by the sales channel for this offer. Rated from A (best) to E (worst) for Cdiscount.
          scoreReasons: [
            {
              code: string|null
Code (or Id) representing the criteria used to assign the offer score by the sales channel.
              reason: string|null
The main reason for the offer score assigned by the sales channel.
            }
          ]
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        loyaltyInformation: {
          isPartOfLoyaltyProgram: boolean|null
Indicates if the offer is part of a loyalty program on the sales channel.
          loyaltyProgramNames: array|null [
Name(s) of the loyalty program(s) the offer is part of.
            string
          ]
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        promotionInformation: {
          isPromotion: boolean|null
Indicates if the offer is part of a promotion campaign on the sales channel.
          promotionLabels: array|null [
Name(s) of the promotion campaign(s) the offer is part of.
            string
          ]
          updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
        }
        competingOffers: [
          {
            sellerName: string|null
Name of the seller on the sales channel.
            sellerRating: number (float)|null
The average rating of the seller, rounded to one decimal place. While the rating scale is usually out of 5 (as is for Cdiscount), the exact scale may vary depending on the sales channel.
            sellerReviewsCount: integer|null
The number of reviews posted by customers for the seller, on the sales channel.
            salesChannelExternalReference: string|null
The identifier for the offer, specific to that sales channel.
            productPageUrl: string|null
URL of the product page on the sales channel.
            productReviewsCount: integer|null
The number of review posted by customer for the product.
            productReviewsAverageRating: integer|null
The average rating of the product reviews, rounded to one decimal place. While the rating scale is usually out of 5 (as is for Cdiscount), the exact scale may vary depending on the sales channel.
            isOnline: boolean|null
Indicates if the offer is published on the sales channel.
            isBestOffer: boolean|null
Indicates if the offer is the best one (buybox) on the sales channel.
            displayedOfferPrice: number (float)|null
Price value displayed on this sales channel.
            deliveryCost: number (float)|null
The shipping cost of the offer with the buybox, on the sales channel.
            updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
            loyaltyInformation: {
              isPartOfLoyaltyProgram: boolean|null
Indicates if the offer is part of a loyalty program on the sales channel.
              loyaltyProgramNames: array|null [
Name(s) of the loyalty program(s) the offer is part of.
                string
              ]
              updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
            }
            promotionInformation: {
              isPromotion: boolean|null
Indicates if the offer is part of a promotion campaign on the sales channel.
              promotionLabels: array|null [
Name(s) of the promotion campaign(s) the offer is part of.
                string
              ]
              updatedAt: string (date-time)|null
Timestamp of the last feedback update by the sales channel.
            }
          }
        ]
        externalCompetingOffer: object|null {
Best competing offer information from external marketplaces (Amazon, Rakuten, Darty, etc).
          marketplaceName: string|null
Source marketplace from which the market price is retrieved.
          price: number (double)|null
Price of the competing offer on the external market.
          deliveryCost: number (double)|null
Shipping fees amount of the competing offer on the external market.
          totalPrice: number (double)|null
Sum of the price and deliverycost of the competing offer on the external market.
          priceIndex: number (double)|null
Ratio between the best offer price and the market price, expressed as a percentage.
          updatedAt: string (date-time)|null
Timestamp of the last update of the market competing offer data.
        }
      }
    }
  ]
  itemsPerPage: integer (int64)
The number of items in the response body.
}

{
Problem details with errors description model.
  detail: string|null
A human-readable explanation specific to this occurence of the problem
  instance: string|null
A URI reference that identifies the specific occurence of the problem.
  traceId: string|null
The response identifier.
  status: integer (int32)|null
The HTTP status code generated by the origin server for this occurence of the problem.
  title: string|null
A short human-readable summary of the problem type.
  type: string (uri)|null
A URI reference that identifies the problem type and provides a human-readable documentation for the problem.
}

{
errors data structure
  detail: string|null
A human-readable explanation specific to this occurence of the problem
  instance: string|null
A URI reference that identifies the specific occurence of the problem.
  traceId: string|null
The response identifier.
  status: integer (int32)|null
The HTTP status code generated by the origin server for this occurence of the problem.
  title: string|null
A short human-readable summary of the problem type.
  type: string (uri)|null
A URI reference that identifies the problem type and provides a human-readable documentation for the problem.
}

{
errors data structure
  detail: string|null
A human-readable explanation specific to this occurence of the problem
  instance: string|null
A URI reference that identifies the specific occurence of the problem.
  traceId: string|null
The response identifier.
  status: integer (int32)|null
The HTTP status code generated by the origin server for this occurence of the problem.
  title: string|null
A short human-readable summary of the problem type.
  type: string (uri)|null
A URI reference that identifies the problem type and provides a human-readable documentation for the problem.
}

{
errors data structure
  detail: string|null
A human-readable explanation specific to this occurence of the problem
  instance: string|null
A URI reference that identifies the specific occurence of the problem.
  traceId: string|null
The response identifier.
  status: integer (int32)|null
The HTTP status code generated by the origin server for this occurence of the problem.
  title: string|null
A short human-readable summary of the problem type.
  type: string (uri)|null
A URI reference that identifies the problem type and provides a human-readable documentation for the problem.
}