PUT /label-payloads/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

createdAt string(date-time)

Created at
id integer(int32)

Id
payload object | null | array | boolean | integer | number | string

Payload

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
rate object | null | array | boolean | integer | number | string

Rate

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
response object | null | array | boolean | integer | number | string

Response

Any of:
object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
shippingRateCacheId integer(int32) | null

Shipping rate cache
status string Required

Status

Values are success or error.
updatedAt string(date-time)

Updated at

PUT /label-payloads/{id}.json

curl \
 --request PUT 'http://api.example.com/v1/label-payloads/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"createdAt":"2025-05-04T09:42:00Z","id":42,"payload":{},"rate":{},"response":{},"shippingRateCacheId":42,"status":"success","updatedAt":"2025-05-04T09:42:00Z"}'

Request examples

{
  "createdAt": "2025-05-04T09:42:00Z",
  "id": 42,
  "payload": {},
  "rate": {},
  "response": {},
  "shippingRateCacheId": 42,
  "status": "success",
  "updatedAt": "2025-05-04T09:42:00Z"
}

PUT /label-payloads/{id}.json

Path parameters

Body Required

payload object | null | array | boolean | integer | number | string

rate object | null | array | boolean | integer | number | string

response object | null | array | boolean | integer | number | string