Confirm Shipment

Confirms shipment for item(s) in a lease.

GET /v3/transactions/:transactionId/confirm-shipment

Request

Path Parameters

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

Headers

Name	Type	Description
Authorization	string	Authorization token

Body

Name	Type	Description
items	array	The items to be shipped to the customer.
items.sku	string	The SKU of the item in the shipment.
items.trackingNumber	string	The tracking number(s).
items.carrier	string	The carrier handling the item's shipment.
items.shipDate	string	The date shipped to the carrier.
items.deliveryDate	array	The item's estimated delivery date.
items.quantity	string	The number of items of this type in this shipment, defaults to one.
items.trackingLink	string	A link to track the shipment on the carrier's website.

Response

200 Returns an empty object

{
    "data": {}
}

404 Could not find the transaction

{
  "error": {
    "statusCode": 404,
    "code": "TransactionNotFound",
    "message": "The transaction with the provided id was not found",
    "data": {}
  }
}

Payload Example

{
  "items": [
    {
      "sku": "ABC123",
      "trackingNumber": "1234-asdf-4321-fdsa",
      "carrier": "Fedex",
      "shipDate": "2018-03-05",
      "deliveryDate": "2018-03-05",
      "quantity": 1,
      "trackingLink": "https://www.fedex.com/apps/fedextrack/?action=track&trackingnumber=12312"
    }
  ]
}

Items is an optional field only necessary for partial shipments. If absent, the entire transaction (all quantities of all SKUs) is marked as shipped.

If an item is present without a quantity, all of that item will be marked as shipped.

If your merchant is opted-in to the pre-authorization flow during agreement signing, we'll automatically attempt to collect the First Payment before confirming the shipment.