Confirm Shipment

Confirms shipment for item(s) in a lease.

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

https://apis.sandbox.flexshopper.com/v3/transactions/{transactionId}/confirm-shipment
Request
Response
Request
Path Parameters
transactionId
required
string
The transaction ID provided at lease generation.
Headers
Authorization
required
string
Authorization token
Body Parameters
items
optional
array
The items to be shipped to the customer.
items.sku
required
string
The SKU of the item in the shipment.
items.trackingNumber
optional
string
The tracking number(s).
items.carrier
required
string
The carrier handling the item's shipment.
items.shipDate
required
string
The date shipped to the carrier.
items.deliveryDate
optional
array
The item's estimated delivery date.
items.quantity
optional
string
The number of items of this type in this shipment, defaults to one.
items.trackingLink
optional
string
A link to track the shipment on the carrier's website.
Response
200: OK
Returns an empty object
{
"data": {}
}
404: Not Found
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.