Body
Required
payload
object | null | array | boolean | integer | number | string Payload
rate
object | null | array | boolean | integer | number | string Rate
response
object | null | array | boolean | integer | number | string Response
-
shippingRateCacheId
integer(int32) | null Shipping rate cache
-
status
string Required Status
Values are
successorerror.
POST
/label-payloads.json
curl \
--request POST 'http://api.example.com/v1/label-payloads.json' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"payload":{},"rate":{},"response":{},"shippingRateCacheId":42,"status":"success"}'
Request examples
{
"payload": {},
"rate": {},
"response": {},
"shippingRateCacheId": 42,
"status": "success"
}
Response examples (200)
{
"createdAt": "2025-05-04T09:42:00Z",
"id": 42,
"payload": {},
"rate": {},
"response": {},
"shippingRateCacheId": 42,
"status": "success",
"updatedAt": "2025-05-04T09:42:00Z"
}