order

order.shipment.update

Update order's shipment information.

put/order.shipment.update.json

Request

Base URL: https://api.api2cart.com/v1.1
URL: https://api.api2cart.com/v1.1/order.shipment.update.json
Auth: API key in header x-api-key and API key in header x-store-key

Request body

shipment_idstring required

Shipment id indicates the number of delivery

order_idstring

Defines the order that will be updated

store_idstring

Store Id

shipment_providerstring

Defines company name that provide tracking of shipment

tracking_linkstring

Defines custom tracking link

is_shippedboolean

Defines shipment's status

delivered_atstring

Defines the date of delivery

replaceboolean

Allows rewrite tracking numbers

send_notificationsboolean

Send notifications to customer after order was created

tracking_providerstring

Defines name of the company which provides shipment tracking

admin_commentstring

Specifies admin's order comment

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Example request

{
  "shipment_id": "200000002",
  "store_id": "1",
  "shipment_provider": "UPS",
  "tracking_link": "http://example.com?someParam=value",
  "is_shipped": true,
  "delivered_at": "2024-08-25T23:56:12+00:00",
  "send_notifications": true,
  "tracking_provider": "Custom tracker",
  "admin_comment": "Test admin comment",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6"
}

Response

successful operation

return_codeinteger

return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.