OF54 - Retrieve offer files once asynchronous offer export is complete (OF52)

Products

OF54 - Retrieve offer files once asynchronous offer export is complete (OF52)

Request

Description

Retrieve each chunk of an offer export file via the URL generated once the asynchronous offer export is complete

Security

Shop-API-Key(Required scopes: ROLE_PARTNER_OFFER_READROLE_SHOP_ADMIN)

Path

tracking_idstringrequired

The asynchronous offer export id

Query

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/dynamic-url/The+URL+is+retrieved+from+OF53+output/OF54?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

text/csv
The offer custom fields are not listed in this list.Each custom field will have its own column, with the custom field code as the column name

Body

activeboolean

Indicates if the offer is active or inactive (not for sale or discontinued)

allow_quote_requestsboolean

Allow customers to request quotes on this offer

available_end_datestring

The date when the offer will be deactivated

available_start_datestring

The date when the offer will be activated

channelsArray of strings

List of channel codes on which the offer can be sold.

currency_iso_codestring

ISO code of the currency

date_createdstring

Date and time of the offer creation

deletedboolean

Indicates whether the offer exists or is deleted

descriptionstring

Offer description

eco_contributionsArray of objects

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

favorite_rankinteger, (int32)

If present, indicates that the offer is a favorite offer ranked

fulfillmentobject

The fulfillment information tied to the offer

is_professionalboolean

Indicates if the store is professional or not

last_updatedstring

Date and time of the last update of the offer

leadtime_to_shipinteger, (int32)

The lead time to ship corresponding to the offer

logistic_classobject

The logistic class associated to the offer

max_order_quantityinteger, (int32)

The maximum order quantity customers must select to be able to place an order for that offer

measurementobject

Measurement of the product

min_order_quantityinteger, (int32)

The minimum order quantity customers must select to be able to place an order for that offer

min_shipping_pricenumber, (with decimals)

Minimum shipping charges for the offer

min_shipping_price_additionalnumber, (with decimals)

Additional shipping charges for the offer

min_shipping_typestring

Shipping method with the minimum shipping charges (code referenced by the operator)

min_shipping_zonestring

Shipping zone with the minimum shipping charges (code referenced by the operator)

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)

Unique offer identifier assigned by Mirakl

ongoing_discount_campaignsArray of objects

Ongoing discount campaigns the offer is currently participating in.
Not returned if the offer is not currently participating in any discount campaign or if Discount Campaign feature is disabled.

package_quantityinteger, (int32)

For one order, customers can only add packages of product items.
The number of items per package is the increment number of that product in an order.

premiumboolean

Indicates if the store is premium or not

price_additional_infostring

Information about the offer price

pricesArray of objects, unique

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

product_skustring

Product identifier within the operator's system

product_tax_codestring

Tax code for the product

quantityinteger, (int32)

Offer quantity available

retail_pricesArray of objects, unique

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

shipping_typesArray of objects

List of shipping types for the offer.
Returned if Export shipping charges and delivery times in OF5X, P11 and the offer webhook is enabled.

shop_idinteger, (int64)

Unique identifier for the store providing this offer (assigned by Mirakl)

shop_namestring

Name of the store providing this offer

shop_skustring

Shop's sku of the offer

state_codestring

Offer condition code

warehousesArray of objects

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

Response

[
  {
    "active": true,
    "allow_quote_requests": true,
    "channels": [ … ],
    "currency_iso_code": "EUR",
    "deleted": false,
    "description": "This is description of the offer 1200: \n Cotton flannelette, brushed both sides for extra comfort and warmth. 165gsm. Includes one flat sheet, one fitted sheet, one pillowcase in single and king single sets, and two pillowcases in all other sets.",
    "eco_contributions": [ … ],
    "fulfillment": { … },
    "is_professional": false,
    "last_updated": "2022-03-03T08:52:10Z",
    "leadtime_to_ship": 10,
    "logistic_class": { … },
    "min_shipping_price": 0,
    "min_shipping_price_additional": 0,
    "min_shipping_type": "CLC",
    "min_shipping_zone": "DOM1",
    "no_commission": false,
    "offer_id": 2003,
    "ongoing_discount_campaigns": [ … ],
    "premium": false,
    "prices": [ … ],
    "product_sku": "MKP100000000193522",
    "quantity": 56,
    "shop_id": 3,
    "shop_name": "* Super Shop",
    "shop_sku": "sku-2003",
    "state_code": "4"
  }
]