Home > API > Order Management > Add shipping details

Add shipping details

Add new shipping details information to the capture.

PATH:

/api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details

PATH PARAMETERS:

orderNumber
required

string

Order number

captureNumber
required

string

Capture number

REQUEST BODY SCHEMA:

type
required

string

Enum: Shipment Return

Shipping type

shippingCompany
required

string <= 200 characters

Company name providing shipping

trackingId
required

string <= 100 characters

Tracking ID

trackingUrl

string <= 2083 characters

Webpage URL to track shipping status

RESPONSES:

200 OK

RESPONSE SCHEMA:

shippingNumber

integer

Shipping number

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum: BusinessError TechnicalError NotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum: Unavailable AskConsumerToConfirm AskConsumerToReEnterData OfferSecurePaymentMethods RequiresSsn AskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

/api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details

Request samples

  • {
    • "type": "string",
    • "shippingCompany": "string",
    • "trackingId": "string",
    • "trackingUrl": "string"
  • }

Response samples

200400
  • {
    • "shippingNumber": 1
    }
  • [
      ...
      • {
        • "type": "string",
        • "code": "string",
        • "message": "string",
        • "customerFacingMessage": "string",
        • "actionCode": "string",
        • "fieldReference": "string"
        }
    ]