Retrieve a list of orderlines

Method : GET

https://admin.vucustom.com/api/:api_version/order_lines?status=&with_tags=&without_tags=&limit&since_idmber=

URL Parameters

Field Name

Description

status

Filter order lines by their current status. Must be one of VU's standard order statuses

with_tags

Comma-separated list of tags. Returns order lines that have ALL specified tags

without_tags

Comma-separated list of tags. Returns order lines that have NONE of the specified tags

limit

Maximum number of records to retrieve per request. Cannot exceed 250

since_id

Show order lines after the specified ID. Used for pagination

Example Request

curl --location 'https://admin.vucustom.com/api/v1/order_lines?status=&with_tags=&without_tags=&limit=&since_id=null'

200 Successful response example

{
  "order_lines": [
    {
      "custom_attributes": {},
      "customer_requested_date": "2024-03-31",
      "estimated_arrival_date": "2024-03-31",
      "ex_factory_date": {
        "current": "2024-03-09",
        "changes": [
          {
            "reason_code": "initial",
            "reason_description": "Initial Value",
            "created_at": "2024-02-23T08:00:40.773Z",
            "estimated_arrival_date": "2024-03-31",
            "ex_factory_date": "2024-03-09"
          }
        ]
      },
      "factory_code": "factory123",
      "id": 12345,
      "line_reference": "59861396",
      "price": 70,
      "product_description": "My Widget",
      "product_id": 12345,
      "quantity": 1,
      "recipe_token": "1609c0e8",
      "status": "new_order",
      "sku": "SKU123",
      "tags": [
        "tag1",
        "tag2"
      ],
      "upc": "UPC123",
      "fulfillments": [
        {
          "created_at": "2024-03-21T08:31:48.653Z",
          "updated_at": "2024-03-21T08:31:48.653Z",
          "quantity": 1,
          "id": 79,
          "tracking_number": "test1",
          "carrier_name": "test",
          "carrier_code": "test",
          "service_name": "test",
          "service_code": "test",
          "recipient_address_1": "test",
          "recipient_city": "test",
          "recipient_name": "test",
          "recipient_state_region": "test",
          "recipient_country": "test",
          "recipient_postal_code": "test",
          "recipient_phone": "test",
          "weight": 0,
          "width": 0,
          "height": 0,
          "length": 0
        }
      ]
    }
  ]
}

401 Unauthorized

The client doesn’t have correct authentication credentials.

{
"errors": "[API] Invalid API key or secret (unrecognized login or wrong password)"
}

422 Unprocessable Entity

5xx Errors

An internal error occurred in VU Admin.

PreviousAdd tags to an order line NextRetrieve a specific order line

Last updated 6 months ago

{ "order_lines": [ { "custom_attributes": {}, "customer_requested_date": "2024-03-31", "estimated_arrival_date": "2024-03-31", "ex_factory_date": { "current": "2024-03-09", "changes": [ { "reason_code": "initial", "reason_description": "Initial Value", "created_at": "2024-02-23T08:00:40.773Z", "estimated_arrival_date": "2024-03-31", "ex_factory_date": "2024-03-09" } ] }, "factory_code": "factory123", "id": 12345, "line_reference": "59861396", "price": 70, "product_description": "My Widget", "product_id": 12345, "quantity": 1, "recipe_token": "1609c0e8", "status": "new_order", "sku": "SKU123", "tags": [ "tag1", "tag2" ], "upc": "UPC123", "fulfillments": [ { "created_at": "2024-03-21T08:31:48.653Z", "updated_at": "2024-03-21T08:31:48.653Z", "quantity": 1, "id": 79, "tracking_number": "test1", "carrier_name": "test", "carrier_code": "test", "service_name": "test", "service_code": "test", "recipient_address_1": "test", "recipient_city": "test", "recipient_name": "test", "recipient_state_region": "test", "recipient_country": "test", "recipient_postal_code": "test", "recipient_phone": "test", "weight": 0, "width": 0, "height": 0, "length": 0 } ] } ] }