TOtopi
ops
ops-orders

Get an order

Changed on

Fetch a single order in our ops tool

get/ops/orders/{id}

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/orders/{id}
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-order:read

Path parameters

idstring regexp required

topi order ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Response

OK response.

idstring regexp required

topi order ID

metadataobject

Metadata you can attach to and order. You can store here any JSON information

offer_idstring regexp required

Reference to the topi offer ID

seller_offer_referencestring required

Seller’s own reference for this order

status'created' | 'confirmed' | 'acknowledged' | 'accepted' | 'partially_fulfilled' | 'completed' | 'canceled' | 'rejected' required

Example response

{
  "assets": [
    {
      "belongs_to_asset_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "offer_line_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "product_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
      "requires_serial_number": false,
      "seller_product_references": [
        {
          "reference": "123ab-5343",
          "source": "sap"
        }
      ],
      "serial_number": "BA-3456786-334-9",
      "status": "shipped",
      "title": "Pro Laptop 64GB",
      "tracking_url": "abc123"
    }
  ],
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "metadata": {
    "tracking_number": "123456"
  },
  "offer_id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "seller_offer_reference": "abc123",
  "status": "confirmed"
}

Changes