Returns the import identifier to track the status of the import.
Import file (CSV or XML or XLSX) to upload. Use multipart/form-data with name file.
Csv format:
"sku";"product-id";"product-id-type";"description";"internal-description";"price";"price-additional-info";"quantity";"min-quantity-alert";"state";"available-start-date";"available-end-date";"discount-price";"discount-start-date";"discount-end-date";"discount-ranges";"allow-quote-requests";"leadtime-to-ship";"min-order-quantity";"max-order-quantity";"package-quantity";"update-delete";"price-ranges";"ecotax";"gift-wrap";"min-quantity-ordered"
discount-ranges and price-ranges as they will be ignored."price[channel=channel code]";"discount-price[channel=channel code]";"discount-start-date[channel=channel code]";"discount-end-date[channel=channel code]";"discount-ranges[channel=channel code]";"price-ranges[channel=channel code]"For Dropship offers, do not use
channel prices, as they will be ignored.pricing-unit to specify the unit corresponding to the submitted price.product-tax-code to facilitate tax calculations."producer-id[EPR category code]"; "eco-contribution-amount[EPR category code]"EPR category code must be one of:
FR-AGROPACK, FR-ASL, FR-DASRIPAT, FR-DBPS, FR-DDS, FR-DEA, FR-DEEE, FR-DISPMED, FR-DIY, FR-EMBM, FR-GF, FR-JOUETS, FR-LUB, FR-MH, FR-MNU, FR-PA, FR-PAP, FR-PCHIM, FR-PMCB, FR-PNEU, FR-TABAC, FR-TLC, FR-VEHICULE, FR-VHU, DE-BATTG, DE-PACK, DE-WEEE, ES-PACK, ES-GPACK, ES-WEEE
curl -i -X POST \
'https://your-instance.mirakl.net/api/offers/imports?shop_id=0' \
-H 'Content-Type: multipart/form-data' \
-F file=string \
-F import_mode=string \
-F operator_format=false \
-F with_products=false{ "import_id": 0, "product_import_id": 0 }
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/imports?end_date=2019-08-24T14%3A15%3A22Z&mode=string&origins=string&page_token=string&shop_id=0&sort=string&start_date=2019-08-24T14%3A15%3A22Z&status=string'{ "data": [ { … } ], "next_page_token": "string", "previous_page_token": "string" }
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/imports/{import}?shop_id=0'{ "date_created": "2019-08-24T14:15:22Z", "has_error_report": true, "import_id": 0, "lines_in_error": 0, "lines_in_pending": 0, "lines_in_success": 0, "lines_read": 0, "mode": "string", "offer_deleted": 0, "offer_inserted": 0, "offer_updated": 0, "reason_status": "string", "status": "string", "type": "string" }
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/imports/{import}/error_report?shop_id=0'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.
Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
<ISO-639>_<ISO-3166> ("en_US") or <ISO-639> ("en") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers?favorite=false&locale=string&max=0&offer_state_codes=string&offset=0&order=string&pricing_channel_code=string&pricing_customer_organization_id=string&product_id=string&shop_id=0&sku=string&sort=string'{ "offers": [ { … } ], "total_count": 0 }
curl -i -X POST \
'https://your-instance.mirakl.net/api/offers?shop_id=0' \
-H 'Content-Type: application/json' \
-d '{
"offers": [
{
"all_prices": [
{
"channel_code": "string",
"discount_end_date": "string",
"discount_start_date": "string",
"unit_discount_price": 0,
"unit_origin_price": 0,
"volume_prices": [
{
"quantity_threshold": 0,
"unit_discount_price": 0,
"unit_origin_price": 0
}
]
}
],
"allow_quote_requests": true,
"available_ended": "string",
"available_started": "string",
"description": "string",
"discount": {
"end_date": "string",
"price": 0,
"ranges": [
{
"price": 0,
"quantity_threshold": 0
}
],
"start_date": "string"
},
"eco_contributions": [
{
"eco_contribution_amount": 0,
"epr_category_code": "string",
"producer_id": "string"
}
],
"internal_description": "string",
"leadtime_to_ship": 0,
"logistic_class": "string",
"max_order_quantity": 0,
"min_order_quantity": 0,
"min_quantity_alert": 0,
"offer_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"package_quantity": 0,
"price": 0,
"price_additional_info": "string",
"pricing_unit": "string",
"product_id": "string",
"product_id_type": "string",
"product_tax_code": "string",
"quantity": 0,
"shop_sku": "string",
"state_code": "string",
"update_delete": "string"
}
]
}'{ "import_id": 0 }
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.
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/api/offers/{offer}?locale=string&pricing_channel_code=string&pricing_customer_organization_id=string&shop_id=0'OK
All prices for the offer
For Dropship specifically: the list of purchasing prices of the offer, also referred to as costs or wholesale prices
Eco-contributions of the offer - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.
Favorite rank for the offer, when the favorite feature is enabled and the offer is a favorite
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.
Custom fields of the offer
Price of the offer
For Dropship specifically: the purchasing price of the offer, also referred to as cost or wholesale price
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
{ "active": true, "all_prices": [ { … } ], "allow_quote_requests": true, "applicable_pricing": { "context": { … }, "discount_end_date": "2019-08-24T14:15:22Z", "discount_start_date": "2019-08-24T14:15:22Z", "price": 0, "unit_discount_price": 0, "unit_origin_price": 0, "volume_prices": [ … ] }, "available_end_date": "2019-08-24T14:15:22Z", "available_start_date": "2019-08-24T14:15:22Z", "category_code": "string", "category_label": "string", "channels": [ "string" ], "currency_iso_code": "string", "description": "string", "eco_contributions": [ { … } ], "favorite_rank": 0, "fulfillment": { "center": { … } }, "inactivity_reasons": [ "string" ], "internal_description": "string", "leadtime_to_ship": 0, "logistic_class": { "code": "string", "label": "string" }, "max_order_quantity": 0, "min_order_quantity": 0, "min_quantity_alert": 0, "min_shipping_price": 0, "min_shipping_price_additional": 0, "min_shipping_type": "string", "min_shipping_zone": "string", "offer_additional_fields": [ { … } ], "offer_id": 0, "package_quantity": 0, "price": 0, "price_additional_info": "string", "product_brand": "string", "product_description": "string", "product_references": [ { … } ], "product_sku": "string", "product_tax_code": "string", "product_title": "string", "quantity": 0, "shipping_deadline": "2019-08-24T14:15:22Z", "shop_sku": "string", "state_code": "string", "total_price": 0 }
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.
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.
Format of the generated files: CSV or JSON (value is either text/csv or application/json). Default to text/csv.
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.
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.
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.
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"}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 'Content-Type: application/json' \
-d '{
"channel_codes": [
"string"
],
"export_type": "string",
"include_fields": [
"string"
],
"include_inactive_offers": false,
"items_per_chunk": 10000,
"last_request_date": "2019-08-24T14:15:22Z",
"megabytes_per_chunk": 10,
"rename_fields": {
"property1": "string",
"property2": "string"
},
"shipping_zones": [
"string"
]
}'{ "tracking_id": "string" }
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/export/async/status/{tracking_id}?shop_id=0'{ "error": { "code": "string", "detail": "string" }, "last_updated": "2019-08-24T14:15:22Z", "status": "string", "urls": [ "string" ] }
List of product's skus separated with comma. Limited to 100 values. One of the two is required product_ids or product_references.
List of the product's identifiers with type (structure: "product_references=<productIdType>|<productId>,<productIdType>|<productId>, ..."). Limited to 100 values. One of the two is required product_ids or product_references.
Example: /api/products/offers?product_references=EAN|3120201243238
List of the channel codes to filter with, using a comma (,) as a separator. 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.
If false, filters the offers with the given channel_codes or all shop channels if no channel_codes are given.
If true, filters on all shop channels and ignores the channel_codes.
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.
List of shipping zones. Filter used to pick shipping prices on one or multiple shipping zones
If false, filters the offers with the given shipping zones.
If true, selects all shop shipping zones and ignores the provided shipping_zones.
Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
<ISO-639>_<ISO-3166> ("en_US") or <ISO-639> ("en") locale for internationalized data translation. The APIs only accept locales that are equivalent to the languages activated in the back-office.
curl -i -X GET \
'https://your-instance.mirakl.net/api/products/offers?all_channels=false&all_offers=false&all_shipping_zones=false&channel_codes=string&locale=string&max=0&offer_state_codes=string&offset=0&order=string&pricing_channel_code=string&pricing_customer_organization_id=string&product_ids=string&product_references=string&shipping_zones=string&shop_id=0&sort=string'{ "products": [ { … } ] }
Import a .csv file to submit all applicable prices for an offer.
The import mode is delete and replace: any existing price that is not submitted will be deleted.
If Price Approval is enabled, this API creates and updates pending prices; ongoing prices will remain.
Returns an import identifier to track the status of the import and retrieve an error report if applicable.
Import CSV file to upload. Use multipart/form-data with name file.
Csv format:
"offer-sku";"price";"discount-price";"discount-start-date";"discount-end-date"price-ranges and discount-ranges Not applicable for Dropship offerschannels Not applicable for Dropship offersstart-date and end-date Not applicable for Dropship offerscustomer-organization-ids and customer-group-ids Not applicable for Dropship offerscurl -i -X POST \
'https://your-instance.mirakl.net/api/offers/pricing/imports?shop_id=0' \
-H 'Content-Type: multipart/form-data' \
-F file=string{ "import_id": "string" }
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/pricing/imports?end_date=2019-08-24T14%3A15%3A22Z&import_id=string&origins=string&page_token=string&shop_id=0&sort=string&start_date=2019-08-24T14%3A15%3A22Z&status=string'{ "data": [ { … } ], "next_page_token": "string", "previous_page_token": "string" }
Only returns lines of offers with at least one offer price in error.
The first column contains the line number in error. The second column contains the error reason.
The returned file is ready to be reimported after the values have been fixed.
Offer prices that were submitted in the price import but don't appear in the error report were successfully imported.
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/pricing/imports/{import_id}/error_report?shop_id=0'Get a CSV file that includes the offers updated and deleted since the last request date.
For deleted offers, only offer-id, product-sku, shop-id, shop-sku, active and deleted columns are returned.
If the last_request_date param is not set the api returns all the active offers (inactive offers can be included with include_inactive_offers parameter).
If offers have custom fields, a column is added for each existing custom field with as header the code of the custom field.
Results are sorted by offer identifier.
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.
List of the channel codes to filter with, using a comma (,) as a separator. 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.
List of the shipping zones codes to filter with, URL-encoded and using a comma (,) as a separator. If specified, only shipping information linked to the given zones will be returned. Otherwise, all shipping information for all zones will be returned.
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.
List of the fields to include, URL-encoded and using a comma (,) as a separator. If specified, only listed fields will be returned.
curl -i -X GET \
'https://your-instance.mirakl.net/api/offers/export?channel_codes=string&include_fields=string&include_inactive_offers=false&last_request_date=2019-08-24T14%3A15%3A22Z&shipping_zones=string&shop_id=0'