Update shipping details
PATH:
/api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
PATH PARAMETERS:
orderNumber required | string Order number |
captureNumber required | string Capture number |
shippingNumber required | integer Shipping number |
REQUEST BODY SCHEMA:
type required | string Enum:ShipmentReturn 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:
RESPONSE SCHEMA:
- { }
RESPONSE SCHEMA:
type | string Enum:BusinessErrorTechnicalErrorNotificationMessage 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:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify Possible next action to make |
fieldReference | string <= 100 characters Reference to field that caused an error |
Path
/api/v3/orders/{orderNumber}/captures/{captureNumber}/shipping-details/{shippingNumber}
Request samples
- {
- "type": "string",
- "shippingCompany": "string",
- "trackingId": "string",
- "trackingUrl": "string"
Response samples
- {
- {
- "type": "string",
- "code": "string",
- "message": "string",
- "customerFacingMessage": "string",
- "actionCode": "string",
- "fieldReference": "string"