Skip to main content
PUT
/
orders
/
{id}
/
shipping
Update Order Shipping
curl --request PUT \
  --url https://api.bitbybit.studio/customer/api/open/v1/orders/{id}/shipping \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "fee": 1,
  "trackingUrl": "<string>",
  "shippingNotes": "<string>",
  "driverName": "<string>",
  "driverPhone": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "fee": 123,
    "shippingStatus": "<string>",
    "awb": "<string>",
    "trackingUrl": "<string>",
    "driverName": "<string>",
    "driverPhone": "<string>",
    "pickupSchedule": "2023-11-07T05:31:56Z",
    "shippingNotes": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Create one in Settings > Developer.

Path Parameters

​
id
string
required

Order ID — the unique identifier of the order.

Body

application/json
​
name
string
​
fee
number
Required range: x >= 0
​
trackingUrl
string<uri>
​
shippingNotes
string
Maximum string length: 500
​
driverName
string
​
driverPhone
string
​
shippingStatus
enum<string>
Available options:
awaiting,
confirmed,
allocated,
out_for_pickup,
picked,
out_for_delivery,
on_hold,
delivered,
rejected

Response

Shipping updated

​
data
object

Summary view of an order's shipping method, returned by the shipping action endpoints.