Skip to Main Content
Riverty Docs
    • Get Started
    • Login
    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
    Max length: 200
    Company name providing shipping
    trackingId
    required
    string
    Max length: 100
    Tracking ID
    trackingUrl
    string
    Max length: 2083
    Webpage URL to track shipping status

    Responses

    • 401 Authorization has been denied for this request.
    • 413 Request body too large.
    • 429 Too many requests.
    • 500 Internal server error.
    Successful RequestUnsuccessful Request, Incorrect Capture Number

    Request Example

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

    Response Example

        
        {
 "shippingNumber": 1
}