Skip to main content
POST
/
shipping
/
shipments
Create a shipment for an order
curl --request POST \
  --url https://api.salesive.com/api/v1/shipping/shipments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "6640c1b2d4e5f60102030406",
  "shippingAddressId": "6635d1e2d4e5f60102030407",
  "carrier": "GIG Logistics",
  "trackingNumber": "GIG-998877",
  "trackingUrl": "https://track.giglogistics.com/GIG-998877",
  "shippingMethod": "standard",
  "shippingCost": 1500,
  "notes": "Leave at front desk"
}
'
{
  "status": 201,
  "success": true,
  "message": "Create a shipment for an order",
  "data": {
    "_id": "6651b2c3d4e5f60102030405",
    "orders": [
      "6640c1b2d4e5f60102030406"
    ],
    "carrier": "GIG Logistics",
    "courier": {
      "id": null,
      "name": "GIG Logistics",
      "image": null
    },
    "shippingAddress": "6635d1e2d4e5f60102030407",
    "shippingOption": null,
    "metadata": {},
    "trackingNumber": "GIG-998877",
    "trackingCode": "GIG-998877",
    "trackingUrl": "https://track.giglogistics.com/GIG-998877",
    "shippingMethod": "standard",
    "shippingCost": 1500,
    "notes": "Leave at front desk",
    "status": "pending",
    "createdAt": "2026-06-28T09:00:00.000Z",
    "updatedAt": "2026-06-28T09:00:00.000Z"
  }
}
Creates a shipment for an order. Provide rateId to create an automatic shipment from a previously fetched courier rate, or omit it and supply carrier/tracking details to create a manual shipment. The order must belong to the store bound to the app token, which is updated with a reference to the new shipment. Requires the WRITE_SHIPPING scope.

Authorizations

​
Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json
​
orderId
string
required

ObjectId of the order to ship.

​
shippingAddressId
string
required

ObjectId of the destination shipping address.

​
carrier
string

Carrier name (manual shipments).

​
rateId
string

Service code or id of a rate from a prior /shipping/rates call (automatic shipments).

​
trackingNumber
string

Tracking number (manual shipments).

​
trackingUrl
string

Tracking URL (manual shipments).

​
shippingMethod
string

Shipping method label.

​
shippingCost
number

Shipping cost (minimum 0).

​
estimatedDelivery
string

Estimated delivery date (ISO date).

​
notes
string

Free-text notes for the shipment.

Response

Create a shipment for an order.

Standard Salesive response envelope. The operation-specific payload is carried in data.

​
status
integer
required

HTTP status code, echoed in the body.

​
success
boolean
required

Whether the request succeeded.

​
message
string
required

Human-readable result message.

​
data
object

A shipment record. Shapes vary slightly by how the shipment was created (manual, automatic label, or ShipDay dispatch); only the most common fields are listed and extra properties may be present.