Skip to main content
GET
/
v1
/
orders
/
{orderId}
/
shipping
Get Order Shipping
curl --request GET \
  --url https://api.roastify.app/v1/orders/{orderId}/shipping \
  --header 'x-api-key: <api-key>'
{
  "status": "processed",
  "trackingNumber": "92346903470341000400704020",
  "trackingUrl": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92346903470341000400704020",
  "estimatedDelivery": "2020-01-01T00:00:00Z",
  "shippingCarrier": "USPS",
  "shippingService": "First"
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Path Parameters

​
orderId
string
required

The Id of the order

Minimum string length: 1
Example:

"1ef87e47-266e-466f-ab06-a64994aefbb0"

Response

Get order shipping details by order Id

Order shipping details

​
status
string
required

Current shipping status

Example:

"processed"

​
trackingNumber
string
required

Tracking number

Example:

"92346903470341000400704020"

​
trackingUrl
string
required

Tracking URL

Example:

"https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=92346903470341000400704020"

​
estimatedDelivery
string
required

Estimated delivery date in ISO string format

Example:

"2020-01-01T00:00:00Z"

​
shippingCarrier
string
required

Shipping carrier

Example:

"USPS"

​
shippingService
string
required

Shipping service

Example:

"First"