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. Fulfillments

Retrieve a list of fulfillments

Method : GET

https://admin.vucustom.com/api/:api_version/fulfillments?tracking_numbers=&limit

URL Parameters

Field Name
Description

tracking_numbers

Comma-separated list of tracking numbers for retrieving multiple fulfillments

limit

Maximum number of records to retrieve. Cannot exceed 250

Example Request
curl --location 'https://admin.vucustom.com/api/v1/fulfillments?tracking_numbers=&limit=null'

200 Successful response example

{
  "fulfillments": [
    {
      "id": 78,
      "tracking_number": "12345",
      "carrier_name": "Fedex",
      "carrier_code": "FED",
      "service_name": "Next day air",
      "service_code": "NDA",
      "weight": "1.5",
      "recipient": {
        "recipient_address_1": "test str 1",
        "recipient_city": "Test",
        "recipient_name": "Test Test",
        "recipient_state_region": "DE",
        "recipient_country": "US",
        "recipient_postal_code": "123",
        "recipient_phone": "123"
      },
      "dimensions": {
        "height": "3.5",
        "width": "3.0",
        "length": "3.0"
      },
      "order_lines": [
        {
          "id": 110,
          "order_line_id": 391,
          "quantity": 1
        }
      ]
    }
  ]
}

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 fulfillment NextOverview

Last updated 6 months ago