post

/client-webhook

This endpoint represents the webhook implemented on the client side to receive a callback from Carriyo for status and label updates.

It is important to note that the Carriyo shipment model will evolve along with the Carriyo product evolution. Hence the webhook endpoint must consume the data that it needs and ignore all other fields and unrecognised fields that might be added in the future.

Authorization

apiKey - x-api-key

Request Parameters

1 Header

Request Body

Schema
object
shipment_id
string
merchant
string
label
object
carrier_account
object
references
object
required
payment
object

For the reverse-shipment payment_mode and pending_amount are not required and will be set to PRE_PAID and 0 accordingly.

required
delivery
object
required
parcels
array[object]
items
array[object]
required
pickup
object
required
dropoff
object
required
post_shipping_info
object
required
custom_attributes
object
order_date
string
1 validation
creation_date
string
1 validation
update_date
string
1 validation
collection
object
rma_id
string

Responses

Schema
object

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
x-api-key