Orders & FulfillmentOrders & Fulfillmentshipping

Get the JSON Schema for additional carrier/service inputs

Returns a JSON Schema document describing any carrier-and-service-specific inputs required to purchase a shipment for the supplied requestToken + rateId. The schema is served verbatim and the calling client should validate the seller’s input against it before issuing purchaseShipment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

rateIdstringRequired
rateId returned by a prior getRates response.
requestTokenstringRequired
requestToken returned by a prior getRates response.

Response

JSON Schema for additional inputs returned successfully
payloadmap from strings to anyOptional

JSON Schema (draft-07 compatible) describing the additional inputs required for the given rateId. Served verbatim from the upstream carrier integration.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error