Add Shipping Details
Path
POST /api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details
Request Parameters
Paramater | Description |
---|---|
orderNumber | Order number |
captureNumber | Capture number |
Request Body
type required
|
string Enum:ShipmentReturn |
shippingCompany required
|
string Company name providing shipping |
trackingId required
|
string Tracking ID |
trackingUrl |
string Webpage URL to track shipping status |
Responses
RESPONSE SCHEMA:
shippingNumber |
integer int32 Shipping number |
RESPONSE SCHEMA:
Array () [
|
RESPONSE SCHEMA:
type |
string |
title |
string |
status |
integer int32 |
detail |
string |
instance |
string |
RESPONSE SCHEMA:
type |
string |
title |
string |
status |
integer int32 |
detail |
string |
instance |
string |
Request
Please select an example:
{
"type": "shipment",
"shippingCompany": "DHL",
"trackingId": "3SBCC000123456",
"trackingUrl": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html"
}
Response
{
"shippingNumber": 1
}