Skip to content
Products
/
/
/
OF52 - Export offers CSV...

OF52 - Export offers CSV or JSON file asynchronously

Request

Description

Export status and files links can be retrieved by calling OF53.
Get a CSV or JSON file that includes the offers updated and deleted since the last request date.

Call Frequency
Recommended usage:
- Differential: every 5 minutes
- Full: once per day
Maximum usage:
- Differential: once per minute
- Full: once per day
Security
Shop-API-Key(Required scopes: ROLE_PARTNER_OFFER_READROLE_SHOP_ADMIN)
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.

Bodyapplication/json
channel_codesArray of strings

List of the channel codes to filter with. If specified, only offers that can be sold on the specified channel(s) will be returned. If not, offers will be returned regardless of their channels.

export_typestring

Format of the generated files: CSV or JSON (value is either text/csv or application/json). Default to text/csv.

Enum: "text/csv", "application/json"

include_fieldsArray of strings

Specify which columns (CSV) or fields (JSON) will be returned. If specified, only the listed columns/fields will be returned, otherwise all will be returned. If combined with rename_fields, include_fields must use the original header/field names.

include_inactive_offersboolean

When calling the API in full mode (i.e. when no last_request_date is provided), inactive offers are not returned. To retrieve both active and inactive offers, set this field to true.
When calling the API in differential mode (i.e. when the last_request_date is provided), both active and inactive offers are returned. This field cannot be used in differential mode otherwise the call fails.

Default:false
items_per_chunkinteger, (int64), [ 10000 .. 1000000 ]

The maximum number of items per chunk

last_request_datestring, (date-time)

Date and time of your last request.
If provided, retrieves all offers updated since this date and time, including deleted and inactive offers.
If not provided, retrieves all active offers only, unless otherwise specified in the include_inactive_offers field.

megabytes_per_chunkinteger, (int64), [ 10 .. 1000 ]

The maximum size in megabytes of a chunk

ongoing_discount_campaign_identifiersArray of strings

List of discount campaign identifiers to filter with. If specified, only offers currently participating in the specified ongoing discount campaign(s) will be returned.

rename_fieldsobject

This is only supported for CSV export. Can be used to modify the name of the CSV headers. The expected format is a JSON object with the original fields as keys and the substitute as value. 

{"offer-id": "offerId", "shop-name":"shopName"}

shipping_zonesArray of strings

If the setting Export shipping charges and delivery times has been enabled, list of the shipping zones codes to filter with. If specified, only shipping information linked to the given zones will be returned. Otherwise, all shipping information for all zones will be returned.

curl -i -X POST \
  'https://your-instance.mirakl.net/api/offers/export/async?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "channel_codes": [
      "B2B"
    ],
    "export_type": "text/csv",
    "include_fields": [
      "active",
      "allow-quote-requests",
      "available-end-date",
      "available-start-date",
      "channels",
      "currency-iso-code",
      "date-created",
      "deleted",
      "description",
      "discount-end-date",
      "discount-price",
      "discount-ranges",
      "discount-start-date",
      "favorite-rank",
      "fulfillment-center-code",
      "leadtime-to-ship",
      "logistic-class",
      "measurement-units",
      "min-shipping-price",
      "min-shipping-price-additional",
      "min-shipping-type",
      "min-shipping-zone",
      "offer-id",
      "origin-price",
      "premium",
      "price",
      "price[channel=B2B]",
      "price-additional-info",
      "price-ranges",
      "product-sku",
      "professional",
      "quantity",
      "shop-id",
      "shop-name",
      "shop-sku",
      "state-code",
      "total-price",
      "ongoing-discount-campaigns"
    ],
    "items_per_chunk": 10000,
    "last_request_date": "2021-11-12T02:34:00Z",
    "megabytes_per_chunk": 100,
    "ongoing_discount_campaign_identifiers": [
      "1_JANUARY_PROMOTION_CAMPAIGN",
      "2_FEBRUARY_PROMOTION_CAMPAIGN"
    ],
    "rename_fields": {
      "active": "active",
      "allow-quote-requests": "allowQuoteRequests",
      "available-end-date": "availableEndDate",
      "available-start-date": "availableStartDate",
      "channels": "channels",
      "currency-iso-code": "currencyIsoCode",
      "date-created": "dateCreated",
      "deleted": "deleted",
      "description": "description",
      "discount-end-date": "discountEndDate",
      "discount-price": "discountPrice",
      "discount-ranges": "discountRanges",
      "discount-start-date": "discountStartDate",
      "favorite-rank": "favoriteRank",
      "fulfillment-center-code": "fulfillmentCenterCode",
      "leadtime-to-ship": "leadtimeToShip",
      "logistic-class": "logisticClass",
      "measurement-units": "measurementUnits",
      "min-shipping-price": "minShippingPrice",
      "min-shipping-price-additional": "minShippingPriceAdditional",
      "min-shipping-type": "minShippingType",
      "min-shipping-zone": "minShippingZone",
      "offer-id": "offerId",
      "ongoing-discount-campaigns": "ongoingDiscountCampaigns",
      "origin-price": "originPrice",
      "premium": "premium",
      "price": "price",
      "price-additional-info": "priceAdditionalinfo",
      "price-ranges": "priceRanges",
      "product-sku": "productSku",
      "professional": "professional",
      "quantity": "quantity",
      "shop-id": "shopId",
      "shop-name": "shopName",
      "state-code": "stateCode",
      "total-price": "totalPrice"
    },
    "shipping_zones": [
      "DOM1"
    ]
  }'

Responses

OK

Bodyapplication/json
tracking_idstring

The offer export tracking Id. If Mirakl detects a duplicate export request, the API will return the tracking_id of the existing export rather than creating a new one.

Response
{
  "tracking_id": "760a9a3a-1a3a-4f0d-93a5-cef772c7c3e5"
}