curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/orders/{id}/ship' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"lines": [
{
"order_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2
}
],
"tracking_number": "1Z999AA10123456784"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fulfillment_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2,
"shipped_quantity": 1,
"sku": "SKU-TENT-2P-GRN",
"total": "102.12",
"unit_price": "49.00"
}
],
"order_number": "ORD-10042",
"payment_status": "string",
"status": "pending",
"total_amount": "102.12",
"updated_at": "2026-08-31T14:22:05Z"
}
Ship an order
Without a body every remaining unit ships. With lines, only those units ship and the order is partially_shipped until the last unit leaves.
PATCH
/
api
/
v1
/
orders
/
{id}
/
ship
curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/orders/{id}/ship' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"lines": [
{
"order_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2
}
],
"tracking_number": "1Z999AA10123456784"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fulfillment_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2,
"shipped_quantity": 1,
"sku": "SKU-TENT-2P-GRN",
"total": "102.12",
"unit_price": "49.00"
}
],
"order_number": "ORD-10042",
"payment_status": "string",
"status": "pending",
"total_amount": "102.12",
"updated_at": "2026-08-31T14:22:05Z"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
lines, only those units
ship and the order is partially_shipped until the last unit leaves.
Path parameters
string
required
Order ID (UUID)
Request body
ShipOrderRequest,null
array,null
Per-line shipped quantities;
null/absent ships all remaining units.string,null
Carrier tracking number to record on the order.
Response
OrderResponse
string (date-time)
required
string
required
string (uuid)
required
string
required
string (uuid)
required
OrderItemResponse[]
required
string
required
string
required
string
required
string
required
string (date-time)
required
Status codes
| Code | Meaning |
|---|---|
200 | Order shipped (fully or partially) |
400 | Order cannot be shipped, or a line exceeds its unshipped quantity |
404 | Order not found |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request PATCH \
--url 'https://api.stateset.com/api/v1/orders/{id}/ship' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"lines": [
{
"order_item_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2
}
],
"tracking_number": "1Z999AA10123456784"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"currency": "USD",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fulfillment_status": "string",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Two-Person Tent",
"product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": 2,
"shipped_quantity": 1,
"sku": "SKU-TENT-2P-GRN",
"total": "102.12",
"unit_price": "49.00"
}
],
"order_number": "ORD-10042",
"payment_status": "string",
"status": "pending",
"total_amount": "102.12",
"updated_at": "2026-08-31T14:22:05Z"
}
Last modified on September 21, 2026