Mark Sale Order as Shipped

​A sale order can be in multiple states (pending, shipped, fulfilled), the default state is pending. In order to mark a sale order as shipped we must call the markSaleOrderAsShipped endpoint with the tracking number, tracking url and the shipping carrier.

Request Payload

The endpoint receives a JSON as request payload that must comply with the following schema:

{
  "shippingCarrier": "CARRIER",
  "trackingNumber": "123ABC",
  "trackingUrl": "https://carrier.com/track/123ABC"
}

In order to mark the sale order as ship we need to make a POST request to the sale-orders resource, the sale order id and pass the api key as a query parameter: ​

curl -X POST -d '{ "shippingCarrier": "CARRIER", "trackingNumber": "123", "trackingUrl": "https://carrier.com/track/123ABC" }' https://services.rxrise.com/api/v1/sale-orders/1/?apiKey=YOUR_API_KEY

Response Payload

The endpoint will always return a JSON with the following schema:

{
  "shippingCarrier": "CARRIER",
  "trackingNumber": "123ABC",
  "trackingUrl": "https://carrier.com/track/123ABC",
  "status": "shipped"
}

Notice how it also returns the sale order status.

Error list

These are the errors returned by this endpoint:

Code	Message	Reason
403	Forbidden	You Don't Have Permission
404	Not Found	Sale Order Not Found
500	Internal Server Error	Service Not Available