riverty logo

Docs

Add Shipping Details

Path

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

Request Parameters

orderNumber required
string
Order number
captureNumber required
string
Capture number

Request Body

application/json

type
required
string Enum: [Shipment, Return]
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

Successful RequestUnsuccessful Request, Incorrect Capture Number

Response Example

    
        {
 "shippingNumber": 1
}
    

Request Example

    
        {
 "type": "shipment",
 "shippingCompany": "DHL",
 "trackingId": "3SBCC000123456",
 "trackingUrl": "https://www.dhl.de/en/privatkunden/dhl-sendungsverfolgung.html"
}