Orders
/
Accept or refuse order lines

Mirakl Marketplace APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Stores

Operations

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Get the status of an asynchronous order export.

Request

Use this API to query the order export status after an API OR13 call.
Until the export via API OR13 is complete, the status returned by API OR14 is PENDING.
You must call API OR14 until you get the COMPLETED status which correspond to a completed and successful export from API OR13.
The URLs in API OR14 response contain all the files from API OR13 export.
Browse those urls and query them using the GET method.
In case of error, the status is FAILED.
In case of export canceled, the status is CANCELED.

Path
tracking_idstringrequired

Id of the previously created asynchronous order export

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/api/orders/async-export/status/{tracking_id}?shop_id=0'

Responses

Order asynchronous export tracking polling success

Bodyapplication/json
last_updatedstring(date-time)

The last updated date of the export

statusstring

Current status of the export, can be 'PENDING', 'FAILED', or 'COMPLETED'

urlsArray of strings

List of generated URLs to call to download each generated chunks

Response
application/json
{
  "last_updated": "2019-08-24T14:15:22Z",
  "status": "string",
  "urls": [
    "string"
  ]
}

Accept or refuse order lines

Request

Accept or refuse order lines in the WAITING_ACCEPTANCE status

Path
order_idstringrequired

Order's identifier

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
order_linesArray of objects(OR21_Request_OrderLines)

List of representations of order line for acceptance

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/accept?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "order_lines": [
      {
        "accepted": true,
        "id": "string"
      }
    ]
  }'

Responses

No Content

Update carrier tracking information for a specific order

Request

If the carrier is not registered, the complete tracking url can be provided.

Path
order_idstringrequired

Order identifier

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
carrier_codestring

The code of a carrier. This information is mandatory for a registered carrier.

carrier_namestring

The name of a carrier. This information is mandatory for an unregistered carrier.

carrier_standard_codestring

Carrier standard code

carrier_urlstring

The tracking url of a carrier. This information is unused for registered carriers (because computed automatically). This information is optional for unregistered carriers.

tracking_numberstring

The carrier tracking number. This information is mandatory for a registered carrier with a URL requiring a tracking number.

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/orders/{order_id}/tracking?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_code": "string",
    "carrier_name": "string",
    "carrier_standard_code": "string",
    "carrier_url": "string",
    "tracking_number": "string"
  }'

Responses

No Content

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations