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. Account Management

Get a list of ship_to_accounts

Method : GET

https://admin.vucustom.com/api/:api_version/ship_to_accounts?updated_at_min=&limit&account_number

URL Parameters

Field Name
Description

updated_at_min

returns a list that was upated after this minimum value.

limit

Default and max 250 - The number of records to retrieve

account_number

filters all records based on the account number

Example Request
curl --location 'https://admin.vucustom.com/api/:api_version/ship_to_accounts?updated_at_min=&limit=null&account_number=null'

200 Successful response example

{
  "ship_to_accounts": [
    {
      "account_number": "123",
      "address_1": "448 Test Street",
      "address_2": "",
      "alternate_name": "ATTN",
      "city": "Lawrence",
      "company_name": "",
      "country": "US",
      "created_at": "2022-10-31T01:54:56.271Z",
      "email": "test@test.com",
      "first_name": "John",
      "id": 12345,
      "last_name": "Doe",
      "phone": "(770) 210-4897",
      "postal_code": "66049",
      "sold_to_account_number": "123",
      "state": "Kansas",
      "updated_at": "2022-10-31T01:54:56.271Z",
      "parent_account_number": "sold_to_123"
    }
  ]
}

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.

PreviousGet a list of sold_to_accountsNextDelete a sold_to_account

Last updated 6 months ago