PRI01 - Import a price file

Request

Description

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.

Call Frequency

Recommended usage: Every 5 minutes

Maximum usage: Once per minute

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.

Bodymultipart/form-data

filestring, (binary)required

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"

1 line = 1 offer price
List prices for the same offer together
Limits: 50 prices can be created for an offer

Volume Pricing users: use additional columns price-ranges and discount-ranges
Channel Pricing users: use additional column channels
Scheduled Pricing users: use additional columns start-date and end-date
Customer Pricing users: use additional columns customer-organization-ids and customer-group-ids
Retail pricing users (only for Dropship offers, with appropriate settings): use additional column price-type to define if you are providing a price or a retail price value

curl -i -X POST \
  https://your-instance.mirakl.net/api/offers/pricing/imports \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@path/to/file'

Responses

Created

Headers

Locationany

Pre-calculated URL to call to get the import status

Bodyapplication/json

import_idstring

Offer pricing import identifier

importIdstringdeprecated

Offer pricing import identifier

Response

{
  "import_id": "7d98c3c0-81fe-407d-9721-d4b01951c8d8"
}