Mirakl Multiple shipments API
The Multiple shipments API from Mirakl — 7 operation(s) for multiple shipments.
OpenAPI Specification
openapi: 3.1.0
info:
description: '{% partial file="/partial-content/product/connect-channel-platform/rest/connect/openapi-description.md" /%}'
title: Mirakl Connect Channel Platform APIs Carriers Multiple shipments API
version: ''
servers:
- description: Connect Channel Platform API
url: https://miraklconnect.com/api/channel-platform
tags:
- name: Multiple shipments
paths:
/api/shipments:
post:
description: '<div class="extension-title">Description</div>
Limited to 1000 shipments at a time
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: On each new shipment</div>
<div class="max-call-frequency">Maximum usage: On each new shipment</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integrating_mirakl/integrate_specific_use_cases/config_multi_shipments_api.htm">More context</a></li></ul></div>'
operationId: ST01
parameters: []
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
shipments:
- invoice_reference: ABCDEF012345
order_id: ORDER_01-A
shipment_additional_information:
- code: DELIVERY_BILL_ID
type: STRING
value: IUYHJ777-98
- code: DELIVERY_BILL_DATE
type: DATE
value: '2024-01-01'
shipment_lines:
- offer_sku: OFFER_SKU_1
package_reference: package_ref_1
quantity: 1
- offer_sku: OFFER_SKU_2
package_reference: package_ref_2
quantity: 3
shipped: false
shipping_from:
warehouse:
code: DEFAULT_WAREHOUSE
tracking:
carrier_code: UPS
carrier_name: UPS
carrier_standard_code: UPS
tracking_number: 1Z2356F1ZJ98L9733M5
tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}
- invoice_reference: ABCDEF012345
order_id: ORDER_01-A
shipment_additional_information: null
shipment_lines:
- order_line_id: ORDER_01-A-1
package_reference: package_ref_1
quantity: 1
- order_line_id: ORDER_01-A-2
package_reference: package_ref_2
quantity: 3
shipped: true
tracking:
carrier_name: Custom carrier
tracking_url: http://www.customcarrier.com/tracking
application/json-auto:
summary: Complete example with value types (application/json)
value:
shipments:
- invoice_reference: string
order_id: string
shipment_additional_information:
- code: string
type: STRING
value: object
shipment_lines:
- offer_sku: string
order_line_id: string
package_reference: string
quantity: 0
shipped: true
shipping_from:
warehouse:
code: string
tracking:
carrier_code: string
carrier_name: string
carrier_standard_code: string
tracking_number: string
tracking_url: string
schema:
$ref: '#/components/schemas/ST01_Request'
responses:
'201':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
shipment_errors:
- message: The order status must be 'SHIPPING' but it is 'SHIPPED'.
order_id: leadtime-ship02-A
- message: Shipment quantity is invalid.
order_id: 7263625-A
shipment_success:
- created_date: '2021-07-06T08:07:22.326Z'
id: f40bf65e-a320-41d3-878c-36ce9e1144ce
invoice_reference: ABCDEF012345
last_updated_date: null
order_id: ORDER_01-A
payment_details: null
shipment_additional_information:
- code: DELIVERY_BILL_ID
type: STRING
value: IUYHJ777-98
shipment_lines:
- offer_sku: OFFER_SKU_01
order_line_id: ORDER_01-A-1
package_reference: package_ref_1
quantity: 1
- offer_sku: OFFER_SKU_02
order_line_id: ORDER_01-A-2
package_reference: package_ref_2
quantity: 3
shipped_date: null
shipping_from:
address:
city: New York City
country_iso_code: USA
state: New York
street_1: 113 MacDougal Street
street_2: 1st floor
zip_code: NY 10012
warehouse:
code: DEFAULT_WAREHOUSE
status: SHIPPING
status_customer_debit: NO_DEBIT
tracking:
carrier_code: UPS
carrier_name: UPS
carrier_standard_code: UPS
last_known_location: null
milestones: []
tracking_number: 1Z2356F1ZJ98L9733M5
tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums={trackingId}
validity_status: null
- created_date: '2021-07-06T09:24:36.326Z'
id: 41c1b9b3-820b-4493-ae7c-1b656377b52b
invoice_reference: null
last_updated_date: null
order_id: ORDER_02-A
payment_details: null
shipment_lines:
- offer_sku: OFFER_SKU_01
order_line_id: ORDER_02-A-1
package_reference: package_ref_1
quantity: 1
- offer_sku: OFFER_SKU_02
order_line_id: ORDER_02-A-2
package_reference: package_ref_2
quantity: 3
shipped_date: '2021-07-06T10:24:36.326Z'
shipping_from:
address:
city: New York City
country_iso_code: USA
state: New York
street_1: 113 MacDougal Street
street_2: 1st floor
zip_code: NY 10012
warehouse: null
status: SHIPPED
status_customer_debit: NO_DEBIT
tracking:
carrier_name: Custom carrier
tracking_url: http://www.customcarrier.com/tracking
application/json-auto:
summary: Complete example with value types (application/json)
value:
shipment_errors:
- message: string
order_id: string
shipment_success:
- created_date: '2023-03-28T09:34:42Z'
id: string
invoice_reference: string
last_updated_date: '2023-03-28T09:34:42Z'
order_id: string
payment_details:
customer_debited_date: '2023-03-28T09:34:42Z'
transaction_date: '2023-03-28T09:34:42Z'
transaction_number: string
shipment_additional_information:
- code: string
type: STRING
shipment_lines:
- offer_sku: string
order_line_id: string
package_reference: string
quantity: 0
shipped_date: '2023-03-28T09:34:42Z'
shipping_from:
address:
city: string
country_iso_code: string
state: string
street_1: string
street_2: string
zip_code: string
warehouse:
code: string
status: SHIPPING
status_customer_debit: NO_DEBIT
tracking:
carrier_code: string
carrier_expected_delivery_date:
earliest:
date: string
offset: string
time: string
latest:
date: string
offset: string
time: string
carrier_name: string
carrier_standard_code: string
last_known_location:
location: string
occurrence_date:
date: string
offset: string
time: string
milestones:
- additional_info:
occurrence_date:
date: string
offset: string
time: string
type: DESTINATION_ARRIVAL
occurrence_date:
date: string
offset: string
time: string
type: IN_TRANSIT
tracking_number: string
tracking_url: string
validity_status: MISSING_TRACKING
schema:
type: object
$ref: '#/components/schemas/ST01_Response_201'
description: Created
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: ST01 - Create shipments
tags:
- Multiple shipments
put:
description: '<div class="extension-title">Description</div>
Limited to 100 shipments at a time
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: At each update of shipments for one or multiple shipment</div>
</div>'
operationId: ST07
parameters: []
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
shipments:
- id: 5b2269b6-3918-43bc-9262-fddd815398f3
shipping_from:
warehouse:
code: WHC1
- id: 0e450a4c-704f-4e2c-845a-71b65b4ff16a
shipping_from:
warehouse:
code: WHC2
application/json-auto:
summary: Complete example with value types (application/json)
value:
shipments:
- id: string
shipping_from:
warehouse:
code: string
schema:
$ref: '#/components/schemas/ST07_Request'
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
shipment_errors:
- id: 0e450a4c-704f-4e2c-845a-71b65b4ff16a
message: Warehouse with code WHC2 does not exist
shipment_success:
- id: 5b2269b6-3918-43bc-9262-fddd815398f3
shipping_from:
address:
city: Paris
country_iso_code: FRA
state: Ile de France
street_1: 12 rue de Lubeck
street_2: null
zip_code: '75016'
warehouse:
code: WHC1
application/json-auto:
summary: Complete example with value types (application/json)
value:
shipment_errors:
- id: string
message: string
shipment_success:
- id: string
shipping_from:
address:
city: string
country_iso_code: string
state: string
street_1: string
street_2: string
zip_code: string
warehouse:
code: string
schema:
type: object
$ref: '#/components/schemas/ST07_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: ST07 - Update shipment shipping origin
tags:
- Multiple shipments
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: at each shipment page display</div>
<div class="max-call-frequency">Maximum usage: at each shipment page display</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integrating_mirakl/integrate_specific_use_cases/config_multi_shipments_api.htm">More context</a></li></ul><div class="extension-title">Pagination</div>
<p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p>
<div class="extension-title">Sort fields</div>
<code>sort</code> field can have the following values:<ul><li><b>dateCreated</b> (Default) - Sort by creation date (asc by default)</li></ul>
</div>'
operationId: ST11
parameters:
- description: Order id for filtering. This parameter can be supplied multiple times (order_id=OR01-A&order_id=OR02-A...).
explode: true
in: query
name: order_id
required: false
schema:
type: array
items:
type: string
style: form
- description: Shipment state code for filtering. This parameter can be supplied multiple times (shipment_state_code=SHIPPING&shipment_state_code=SHIPPED...).
explode: true
in: query
name: shipment_state_code
required: false
schema:
type: array
items:
type: string
style: form
- description: 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...).
explode: true
in: query
name: shipment_customer_debit_state_code
required: false
schema:
type: array
items:
type: string
style: form
- description: Filter shipments updated after the given date.
explode: true
in: query
name: last_updated_from
required: false
schema:
type: string
format: date-time
style: form
- description: Filter shipments updated before the given date.
explode: true
in: query
name: last_updated_to
required: false
schema:
type: string
format: date-time
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
data:
- created_date: '2021-06-25T15:28:00.336Z'
id: 4dd549d5-3b5b-4237-a77c-a084359f93fc
invoice_reference: ABCDEF012345
last_updated_date: '2021-07-06T09:24:36.326Z'
order_id: ORDER_01-A
payment_details: null
shipment_lines:
- offer_sku: OFFER_SKU_01
order_line_id: ORDER_01-A-1
package_reference: package_ref_1
quantity: 1
- offer_sku: OFFER_SKU_02
order_line_id: ORDER_01-A-2
package_reference: package_ref_2
quantity: 3
shipped_date: '2021-07-06T10:24:36.326Z'
shipping_from:
address:
city: New York City
country_iso_code: USA
state: New York
street_1: 113 MacDougal Street
street_2: 1st floor
zip_code: NY 10012
warehouse:
code: DEFAULT_WAREHOUSE
status: SHIPPED
status_customer_debit: NO_DEBIT
tracking:
carrier_code: UPS
carrier_estimated_delivery_date:
earliest:
date: '2024-02-12'
offset: Z
time: '16:30:00'
latest:
date: '2024-02-14'
offset: Z
time: '18:19:42'
carrier_name: UPS
carrier_standard_code: UPS
last_known_location:
location: PARIS
occurrence_date:
date: '2024-02-08'
offset: null
time: null
milestones:
- additional_info:
occurrence_date:
date: '2023-12-22'
offset: null
time: '14:25:00'
type: DELIVERY_ATTEMPTED
occurrence_date:
date: '2024-02-08'
offset: +02:00
time: '12:50:00'
type: IN_TRANSIT
- additional_info:
occurrence_date:
date: '2023-12-22'
offset: null
time: '14:25:00'
type: DESTINATION_ARRIVAL
occurrence_date:
date: '2024-02-08'
offset: null
time: null
type: OUT_FOR_DELIVERY
- additional_info: null
occurrence_date:
date: '2024-02-08'
offset: null
time: '16:45:10'
type: DELIVERED
tracking_number: 1315A26
tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1315A26
validity_status: VERIFIED
- created_date: '2021-07-01T10:30:00.000Z'
id: 297bf287-37d7-4490-8849-58356602e800
invoice_reference: ABCDEF012345
last_updated_date: '2021-07-06T09:24:36.326Z'
order_id: ORDER_02-A
payment_details: null
shipment_additional_information:
- code: DELIVERY_BILL_ID
type: STRING
value: IUYHJ777-98
shipment_lines:
- offer_sku: OFFER_SKU_03
order_line_id: ORDER_02-A-1
package_reference: package_ref_1
quantity: 10
- offer_sku: OFFER_SKU_04
order_line_id: ORDER_02-A-2
package_reference: package_ref_2
quantity: 2
shipped_date: '2021-07-06T10:24:36.326Z'
shipping_from:
address:
city: New York City
country_iso_code: USA
state: New York
street_1: 113 MacDougal Street
street_2: 1st floor
zip_code: NY 10012
warehouse: null
status: CLOSED
status_customer_debit: NO_DEBIT
tracking:
carrier_code: null
carrier_estimated_delivery_date:
earliest:
date: '2024-03-10'
offset: null
time: null
latest:
date: '2024-03-14'
offset: null
time: '18:19:42'
carrier_name: La Poste
carrier_standard_code: null
last_known_location:
location: PARIS
occurrence_date:
date: '2024-03-06'
offset: -02:00
time: '12:00:02'
milestones: []
tracking_number: 0AAC590
tracking_url: http://www.laposte.com/suivi/0AAC590
validity_status: UNVERIFIED
- created_date: '2021-07-01T10:30:00.000Z'
id: e47cef257-37d7-4490-8849-58356bc02ea07
invoice_reference: null
last_updated_date: '2021-07-06T09:24:36.326Z'
order_id: ORDER_03-A
payment_details: null
shipment_lines:
- offer_sku: OFFER_SKU_03
order_line_id: ORDER_03-A-1
quantity: 10
- offer_sku: OFFER_SKU_04
order_line_id: ORDER_03-A-2
quantity: 2
shipped_date: null
status: SHIPPING
status_customer_debit: NO_DEBIT
tracking:
carrier_code: null
carrier_estimated_delivery_date: null
carrier_name: La Poste
carrier_standard_code: null
last_known_location:
location: LONDON
occurrence_date:
date: '2024-02-08'
offset: +01:00
time: 06:07:08
milestones: []
tracking_number: 0AAC590
tracking_url: http://www.laposte.com/suivi/0AAC590
validity_status: UNCOVERED
- created_date: '2022-07-25T15:28:00.336Z'
id: d6ce3a1d-6c21-4535-bce7-bd44777823d4
invoice_reference: null
last_updated_date: '2022-08-06T09:24:36.326Z'
order_id: ORDER_04-A
payment_details:
customer_debited_date: '2022-07-25T15:28:00.336Z'
transaction_date: '2022-07-25T15:28:00.336Z'
transaction_number: tx-123456
shipment_lines:
- offer_sku: OFFER_SKU_01
order_line_id: ORDER_04-A-1
quantity: 1
shipped_date: '2022-08-06T10:24:36.326Z'
status: SHIPPED
status_customer_debit: DEBIT_OK
tracking:
carrier_code: UPS
carrier_estimated_delivery_date: null
carrier_name: UPS
carrier_standard_code: UPS
last_known_location:
location: LONDON
occurrence_date:
date: '2024-02-08'
offset: null
time: null
milestones: []
tracking_number: 1315A32
tracking_url: https://wwwapps.ups.com/WebTracking/track?track=yes&trackNums=1315A32
validity_status: null
next_page_token: bGltaXQ9MTAmYWZ0ZXI9MjAxOS0wOC0xMlQxMDowMzoyMy43NzNaJmFmdGVyPU1JUi1RTDNXVE1DSi1BJmFmdGVyPTEmc29ydD1kYXRlQ3JlYXRlZCxBU0M=
previous_page_token: null
application/json-auto:
summary: Complete example with value types (application/json)
value:
data:
- created_date: '2023-03-28T09:34:42Z'
id: string
invoice_reference: string
last_updated_date: '2023-03-28T09:34:42Z'
order_id: string
payment_details:
customer_debited_date: '2023-03-28T09:34:42Z'
transaction_date: '2023-03-28T09:34:42Z'
transaction_number: string
shipment_additional_information:
- code: string
type: STRING
shipment_lines:
- offer_sku: string
order_line_id: string
package_reference: string
quantity: 0
shipped_date: '2023-03-28T09:34:42Z'
shipping_from:
address:
city: string
country_iso_code: string
state: string
street_1: string
street_2: string
zip_code: string
warehouse:
code: string
status: SHIPPING
status_customer_debit: NO_DEBIT
tracking:
carrier_code: string
carrier_expected_delivery_date:
earliest:
date: string
offset: string
time: string
latest:
date: string
offset: string
time: string
carrier_name: string
carrier_standard_code: string
last_known_location:
location: string
occurrence_date:
date: string
offset: string
time: string
milestones:
- additional_info:
occurrence_date:
date: string
offset: string
time: string
type: DESTINATION_ARRIVAL
occurrence_date:
date: string
offset: string
time: string
type: IN_TRANSIT
tracking_number: string
tracking_url: string
validity_status: MISSING_TRACKING
next_page_token: string
previous_page_token: string
schema:
type: object
$ref: '#/components/schemas/ST11_Response_200'
description: OK
security:
- Operator-Bearer-Token: []
- OAuth-2: []
summary: ST11 - List shipments
tags:
- Multiple shipments
/api/shipments/delete:
put:
description: '<div class="extension-title">Description</div>
Limited to 1000 shipments at a time
<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: On each shipment deletion</div>
<div class="max-call-frequency">Maximum usage: On each shipment deletion</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/integrating_mirakl/integrate_specific_use_cases/config_multi_shipments_api.htm">More context</a></li></ul></div>'
operationId: ST06
parameters: []
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
shipments:
- id: e2055970-dd6c-4d66-b005-096d6e6e0f30
- id: 89174558-2845-44ef-bd57-78db027947f7
- id: 14d134a1-eb3a-442c-b16c-05a35486d1bf
application/json-auto:
summary: Complete example with value types (application/json)
value:
shipments:
- id: string
schema:
$ref: '#/components/schemas/ST06_Request'
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
deletion_errors:
- id: 89174558-2845-44ef-bd57-78db027947f7
message: Shipment with id '89174558-2845-44ef-bd57-78db027947f7' is not in SHIPPING status and cannot be deleted.
- id: 14d134a1-eb3a-442c-b16c-05a35486d1bf
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-multiple-shipments-api-openapi.yml