TOtopi
ops
ops-orders

Create a shipment

Changed on

Add shipment info to an existing order.

post/ops/shipment

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/shipment
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-order:edit

Request body

order_idstring regexp required

topi order ID

seller_idstring required

id of the seller owner of this order

Example request

{
  "order_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_id": "abc123",
  "serial_numbers": [
    {
      "asset_id": "abc123",
      "seller_product_reference": {
        "reference": "123ab-5343",
        "source": "sap"
      },
      "serial_number": "BA-3456786-334-9",
      "tracking_url": "abc123"
    }
  ]
}

Response

OK response.

seller_idstring required

id of the seller owner of this order

Example response

{
  "seller_id": "abc123",
  "serial_numbers": [
    {
      "asset_id": "abc123",
      "seller_product_reference": {
        "reference": "123ab-5343",
        "source": "sap"
      },
      "serial_number": "BA-3456786-334-9",
      "tracking_url": "abc123"
    }
  ]
}

Changes

  • 0802da91479fRevision changes
    • warning

      the /// request property's maxLength was set to 255

    • warning

      the /// request property's maxLength was set to 255

  • ac6979514123Revision changes
    • info

      api operation id order.createShipment removed and replaced with order#createShipment