Mark Order as Shipped

post https://api.essentialhub.com/api/v2/order_stores/{order_store_id}/orders/{order_number}/shipments

Mark an order as shipped/fulfilled in the e-commerce system and populate information about the shipment.

Path Params

order_store_id

int32

required

order_number

string

required

Body Params

shipping_cost

double

required

Shipping cost in US dollars/cents

ship_date

date-time

required

Date/Time of shipment

tracking_number

string

required

Shipment tracking number

carrier

string

required

Carrier used for shipment

service

string

required

Service used for shipment

notify

boolean

Indicates that e-commerce platform should send a shipment notification. Defaults to true

Response

Language

Credentials

Bearer


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.essentialhub.com/api/v2/order_stores/order_store_id/orders/order_number/shipments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "carrier": "4px",
8
  "service": "collect_economy"
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Ship order