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

200 Success

RESPONSE SCHEMA:

shippingNumber

integer int32

Shipping number

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

code

string

Confirmation or error code

message

string

Message content

customerFacingMessage

string

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Action codes

fieldReference

string

Reference to field that caused an error

]
401 Authorization has been denied for this request.

RESPONSE SCHEMA:

type

string

title

string

status

integer int32

detail

string

instance

string

429 Too many requests.

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
}