Confirm Shipment

Confirms shipment for item(s) in a lease.

POST /v3/transactions/{transactionId}/confirm-shipment

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name	Type	Required	Description
x-consumer-custom-id	string		Consumer data with the format "channel:vendorId"

Path Parameters

The endpoint path expects parameters.

Name	Type	Required	Description
transactionId	string		The transaction ID provided at lease generation.

Body

You must provide a JSON payload.

Name	Type	Required	Description
items	array		The list of items to be confirmed.
items[].sku	string		Item's sku
items[].trackingNumber	string		The tracking number
items[].carrier	string		The carrier handling the item's shipment.
items[].shipDate	string		The date shipped to the carrier.
items[].deliveryDate	string		The date shipped to the carrier.
items[].quantity	number		Quantity, defaults to the number ordered if not present.
items[].trackingLink	string		A link to track the shipment on the carrier's website.

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

200

{
    "data": {}
}

400

{
    "error": {
        "statusCode": 400,
        "code": "UserAlreadyExists",
        "message": "User already exists with email [email protected]",
        "data": {}
    }
}

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	object		N/A