Mirakl Marketplace APIs (latest-release)

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

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations

Create shipments

Request

Limited to 1000 shipments at a time

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

shipmentsArray of objects(ST01_Request_Shipments)[ 1 .. 1000 ] items

Shipments list

curl -i -X POST \
  'https://your-instance.mirakl.net/api/shipments?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "invoice_reference": "string",
        "order_id": "string",
        "shipment_additional_information": [
          {
            "code": "string",
            "type": "string",
            "value": {}
          }
        ],
        "shipment_lines": [
          {
            "offer_sku": "string",
            "order_line_id": "string",
            "package_reference": "string",
            "quantity": 1
          }
        ],
        "shipped": false,
        "shipping_from": {
          "warehouse": {
            "code": "string"
          }
        },
        "tracking": {
          "carrier_code": "string",
          "carrier_name": "string",
          "carrier_standard_code": "string",
          "tracking_number": "string",
          "tracking_url": "string"
        }
      }
    ]
  }'

Responses

Created

Bodyapplication/json

shipment_errorsArray of objects(ST01_Response_201_ShipmentErrors)

Shipment creation errors

shipment_successArray of objects(ST01_Response_201_ShipmentSuccess)

Shipment creation success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

Update shipment shipping origin

Request

Limited to 100 shipments at a time

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

shipmentsArray of objects(ST07_Request_Shipments)[ 1 .. 100 ] items

Shipments list

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string",
        "shipping_from": {
          "warehouse": {
            "code": "string"
          }
        }
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_errorsArray of objects(ST07_Response_200_ShipmentErrors)

Shipment update errors

shipment_successArray of objects(ST07_Response_200_ShipmentSuccess)

Shipment update success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

List shipments

Request

Query

order_idArray of strings

Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).

shipment_state_codeArray of strings

Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).

shipment_customer_debit_state_codeArray of strings

Shipment customer debit state code for filtering. This parameter can be supplied multiple times (shipment_customer_debit_state_code=WAITING_TAX_CONFIRMATION&shipment_customer_debit_state_code=DEBIT_OK...).

last_updated_fromstring(date-time)

Filter shipments updated after the given date.

last_updated_tostring(date-time)

Filter shipments updated before the given date.

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.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/shipments?last_updated_from=2019-08-24T14%3A15%3A22Z&last_updated_to=2019-08-24T14%3A15%3A22Z&order_id=string&page_token=string&shipment_customer_debit_state_code=string&shipment_state_code=string&shop_id=0&sort=string'

Responses

Bodyapplication/json

dataArray of objects(ST11_Response_200_Data)

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Delete shipments

Request

Limited to 1000 shipments at a time

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

shipmentsArray of objects(ST06_Request_Shipments)[ 1 .. 1000 ] items

Shipment ids

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments/delete?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_errorsArray of objects(ST06_Response_200_ShipmentErrors)

Shipment workflow update errors

shipment_successArray of objects(ST06_Response_200_ShipmentSuccess)

Shipment workflow update success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

List items to ship

Request

Query

order_idArray of strings

Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).

fulfillment_center_codeArray of strings

Fulfillment center code for filtering. This parameter can be supplied multiple times (fulfillment_center_code=ABC&fulfillment_center_code=DEF...).

shipping_date_fromstring(date-time)

Filter items that moved to shipping status after the given date.

shipping_date_tostring(date-time)

Filter items that moved to shipping status before the given date.

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.

page_tokenstring

Token retrieved from next_page_token or previous_page_token to get to next

sortstring

How the results should be sorted. Must follow "sort=criterion,direction" format as described in Mirakl API Documentation

curl -i -X GET \
  'https://your-instance.mirakl.net/api/shipments/items_to_ship?fulfillment_center_code=string&order_id=string&page_token=string&shipping_date_from=2019-08-24T14%3A15%3A22Z&shipping_date_to=2019-08-24T14%3A15%3A22Z&shop_id=0&sort=string'

Responses

Bodyapplication/json

dataArray of objects(ST12_Response_200_Data)

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

application/json

{
  "data": [
    { … }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Update carrier tracking information for shipments

Request

If the carrier is not registered, the complete tracking url can be provided. Limited to 1000 shipments at a time.

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

shipmentsArray of objects(ST23_Request_Shipments)[ 1 .. 1000 ] items

Shipments list

curl -i -X POST \
  'https://your-instance.mirakl.net/api/shipments/tracking?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string",
        "tracking": {
          "carrier_code": "string",
          "carrier_name": "string",
          "carrier_standard_code": "string",
          "tracking_number": "string",
          "tracking_url": "string"
        }
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_errorsArray of objects(ST23_Response_200_ShipmentErrors)

Shipment workflow update errors

shipment_successArray of objects(ST23_Response_200_ShipmentSuccess)

Shipment workflow update success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

Validate shipments as shipped

Request

Limited to 1000 shipments at a time

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

shipmentsArray of objects(ST24_Request_Shipments)[ 1 .. 1000 ] items

Shipment ids

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments/ship?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_errorsArray of objects(ST24_Response_200_ShipmentErrors)

Shipment workflow update errors

shipment_successArray of objects(ST24_Response_200_ShipmentSuccess)

Shipment workflow update success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

Validate shipments as ready to pick up

Request

Limited to 1000 shipments at a time

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

shipmentsArray of objects(ST26_Request_Shipments)[ 1 .. 1000 ] items

Shipment ids

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments/ready_for_pick_up?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string"
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_errorsArray of objects(ST26_Response_200_ShipmentErrors)

Shipment workflow update errors

shipment_successArray of objects(ST26_Response_200_ShipmentSuccess)

Shipment workflow update success

Response

application/json

{
  "shipment_errors": [
    { … }
  ],
  "shipment_success": [
    { … }
  ]
}

Update shipment additional information

Request

Limited to 100 shipments at a time

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

shipmentsArray of objects(ST31_Request_Shipments)[ 1 .. 100 ] items

List of shipments additional information

curl -i -X PUT \
  'https://your-instance.mirakl.net/api/shipments/additional_information?shop_id=0' \
  -H 'Content-Type: application/json' \
  -d '{
    "shipments": [
      {
        "id": "string",
        "shipment_additional_information": [
          {
            "code": "string",
            "type": "string",
            "value": {}
          }
        ]
      }
    ]
  }'

Responses

Bodyapplication/json

shipment_update_errorsArray of objects(ST31_Response_200_ShipmentUpdateErrors)

Shipment additional information update errors

shipment_update_successArray of objects(ST31_Response_200_ShipmentUpdateSuccess)

Shipment additional information update success

Response

application/json

{
  "shipment_update_errors": [
    { … }
  ],
  "shipment_update_success": [
    { … }
  ]
}

Mirakl Marketplace APIs (latest-release)

Stores

Platform Settings

Invoicing and Accounting

Products

Messages

Offers

Orders

Incidents

Picklists

Promotions

Returns

Multiple shipments

Create shipments

RequestExpand all

Responses

Update shipment shipping origin

RequestExpand all

Responses

List shipments

Request

Responses

Delete shipments

RequestExpand all

Responses

List items to ship

Request

Responses

Update carrier tracking information for shipments

RequestExpand all

Responses

Validate shipments as shipped

RequestExpand all

Responses

Validate shipments as ready to pick up

RequestExpand all

Responses

Update shipment additional information

RequestExpand all

Responses

Request

Request

Request

Request

Request

Request

Request