Offers

Operations

OF22 - Get information about an offer

Request

Call Frequency

Recommended usage: At each offer page display

Maximum usage: At each offer page display

Localization

This resource supports locale parameter (see documentation)

Localized output fields will be highlighted with an icon:

Security

Front-Bearer-Token or OAuth-2

Path

offerinteger, (int64)required

Offer identifier

Query

pricing_channel_codestring

Filter used to pick prices on a specific channel

pricing_customer_organization_idstring

For Customer Pricing users only. Customer identifier code the API will use to return all prices and applicable price for this organization. Ignored if value does not exist.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/offers/{offer}?pricing_channel_code=string&pricing_customer_organization_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

activebooleanrequired

Is the offer active

all_pricesArray of objectsrequired

All prices for the offer
For Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices

allow_quote_requestsboolean

Whether the offer is eligible for quotation

applicable_pricingobject

Pricing defined for the offer, including the prices for the selected channel if available
For Dropship specifically: the list of applicable purchasing prices of the offer, also referred to as costs or wholesale prices.

available_end_datestring, (date-time)

Available end date

available_start_datestring, (date-time)

Available start date

category_codestringrequired

Product category code

category_labelstringrequired

Product category label

channelsArray of strings, uniquerequired

List of channel codes on which the offer can be sold

currency_iso_codestringrequired

The currency of the shop (iso format)

Enum: "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR"

descriptionstringrequired

Offer description

eco_contributionsArray of objects, <= 20 items

Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.

favorite_rankinteger, (int32)

Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite

fulfillmentobjectrequired

Fulfillment information

inactivity_reasonsArray of strings

Reasons for offers inactivity, mandatory if an offer is inactive

leadtime_to_shipinteger, (int32)required

Offer's lead time to ship value. If this value has been set to 0, value is returned as 1 (unless platform's default lead time to ship value is also 0). If no lead time to ship was specified for the offer, platform's default value is returned.

logistic_classobjectrequired

The logistic class associated to the offer

max_order_quantityinteger, (int32)required

Highest quantity of product items per order

min_order_quantityinteger, (int32)required

Lowest quantity of product items per order

min_quantity_alertinteger, (int32)required

Minimum quantity of the offer

min_shipping_pricenumber, (with decimals)required

Unit price of the minimum shipping rate

min_shipping_price_additionalnumber, (with decimals)required

Additional unit price associated to the minimum shipping rate

min_shipping_typestringrequired

Code of the shipping type associated to the minimum shipping rate

min_shipping_zonestringrequired

Code of the shipping zone associated to the minimum shipping rate

modelstring

Shop platform model, current possible values :

MARKETPLACE
DROPSHIP
ONE_CREDITOR

Enum: "MARKETPLACE", "DROPSHIP", "ONE_CREDITOR"

msrpnumber, (with decimals)

The retail price recommendation, also referred to as manufacturer's suggested retail price (MSRP) or recommended retail price (RRP).
Applicable only for Dropship offers.

offer_additional_fieldsArray of objects

Custom fields of the offer

offer_idinteger, (int64)required

Identifier of the offer

package_quantityinteger, (int32)required

Indivisible quantity of the same product

pricenumber, (with decimals)

Price of the offer
For Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price

price_additional_infostring

Additional price information for the offer

product_brandstring

Brand of the product

product_descriptionstring

Description of the product

product_referencesArray of objectsrequired

Product references

product_skustringrequired

Product SKU

product_tax_codestring

Offer product tax code

product_titlestringrequired

Product title

quantityinteger, (int32)required

Available quantity of the offer

retail_pricesArray of objects

List retail prices for the offer, also referred to as selling prices.
Applicable only for Dropship offers.

shipping_deadlinestring, (date-time)required

Estimated shipping date, that includes business closing days and cut-off configured on the platform. Add the earliest and latest delivery times to calculate the estimated delivery date to customers

shop_gradenumber, (with decimals)required

Grade of the shop which proposes the offer

shop_idinteger, (int64)required

Identifier of the shop which proposes the offer

shop_namestringrequired

Name of the shop which proposes the offer

shop_skustringrequired

The offer's shop SKU

state_codestringrequired

Offer condition

total_pricenumber, (with decimals)

Total price of the offer (price + minimum shipping rate)
For Dropship specifically: the purchasing price of the offer + minimum shipping rate

warehousesArray of objects

The breakdown of the available quantities of the offer in each warehouse.

discountobjectdeprecated

Discount of the offer

Please use 'applicablePricing' instead

Response

{
  "active": true,
  "all_prices": [
    { … },
    { … },
    { … }
  ],
  "allow_quote_requests": false,
  "applicable_pricing": {
    "channel_code": "US",
    "context": { … },
    "discount_end_date": "2023-01-31T22:00:00Z",
    "discount_start_date": "2023-03-31T22:00:00Z",
    "price": 29,
    "unit_discount_price": 29,
    "unit_origin_price": 30,
    "volume_prices": [ … ]
  },
  "available_end_date": "2019-09-29T22:00:00Z",
  "available_start_date": "2019-03-31T22:00:00Z",
  "category_code": "3016100",
  "category_label": "Shoes",
  "channels": [
    "FR",
    "US"
  ],
  "currency_iso_code": "USD",
  "description": "Offer for product MKP100000000154824",
  "discount": {
    "discount_price": null,
    "end_date": "2019-04-29T22:00:00Z",
    "origin_price": 50,
    "ranges": [ … ],
    "start_date": "2019-03-31T22:00:00Z"
  },
  "eco_contributions": [
    { … },
    { … }
  ],
  "fulfillment": {
    "center": { … }
  },
  "inactivity_reasons": [
    "SHOP_NOT_OPEN",
    "ZERO_QUANTITY"
  ],
  "leadtime_to_ship": 10,
  "logistic_class": {
    "code": "M",
    "label": "Medium"
  },
  "max_order_quantity": 5,
  "min_order_quantity": 1,
  "min_quantity_alert": 1,
  "min_shipping_price": 0,
  "min_shipping_price_additional": 0,
  "min_shipping_type": "CLC",
  "min_shipping_zone": "DOM1",
  "model": "MARKETPLACE",
  "offer_additional_fields": [
    { … },
    { … },
    { … }
  ],
  "offer_id": 2135,
  "package_quantity": 1,
  "price": 49,
  "price_additional_info": "Apply Discount prices",
  "product_brand": "Capture",
  "product_description": "Cobalt, fuchsia, leopard print: imitation suede upper. Synthetic lining, upper and sole. Almond toe court with cushioned sole. Heel height 9cm.",
  "product_references": [
    { … }
  ],
  "product_sku": "MKP100000000154824",
  "product_title": "Capture Coloured Court Shoe - 10",
  "quantity": 1000000,
  "shipping_deadline": "2019-09-01T23:59:59.999Z",
  "shop_grade": 4,
  "shop_id": 2000,
  "shop_name": "ACME SHOP",
  "shop_sku": "S2002",
  "state_code": "11",
  "total_price": 49,
  "warehouses": [
    { … },
    { … }
  ]
}