VU CUSTOM
Developer Docs
Developer Docs
  • VU OS Admin API Overview
  • Account Management
    • Overview
    • Create a sold_to_account
    • Create a ship_to_account
    • Batch update sold_to_account
    • Batch update ship_to_account
    • Get a list of sold_to_accounts
    • Get a list of ship_to_accounts
    • Delete a sold_to_account
    • Delete a ship_to_account
  • Orders
    • Overview
    • Create an order
    • Get an order
    • Get a list of orders
    • Update an order
    • Delete an order
    • Add tags to an order
    • Add tags to many orders
    • Delete tags from an order
    • Delete tags from many orders
  • Products
    • Overview
    • Create a product
    • Get a list of products
    • Get a specific product
    • Delete a product
  • Recipes
    • Overview
    • Retrieving Recipes
  • Fulfillments
    • Overview
    • Create a fulfillment
    • Retrieve a fulfillment
    • Retrieve a list of fulfillments
  • Order Lines
    • Overview
    • Add tags to an order line
    • Retrieve a list of orderlines
    • Retrieve a specific order line
    • Delete tags from an order line
    • Update a specific order line
  • Integration
    • Integrate the Customizer with Your Frontend
    • Understanding Recipe IDs in VU Custom
    • Styling the Customizer
    • Test the Customizer
    • Webhooks
Powered by GitBook
On this page
  1. Order Lines

Retrieve a specific order line

Method : GET

https://admin.vucustom.com/api/:api_version/order_lines?id=&line_reference=

URL Parameters

Field Name
Description

id

System-generated unique identifier for the order line

line_reference

External reference number for the order line

Example Request
curl --location 'https://admin.vucustom.com/api/:api_version/order_lines?id=&line_reference='=null'

200 Successful response example

{
  "order_line": {
    "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.

PreviousRetrieve a list of orderlinesNextDelete tags from an order line

Last updated 6 months ago