VU CUSTOM
Developer Docs
User GuidesDeveloper DocsBest Practice and FAQs
Developer Docs
User GuidesDeveloper DocsBest Practice and FAQs
  • 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
Powered by GitBook
On this page
  1. Account Management

Create a sold_to_account

Method : POST 

https://admin.vucustom.com/api/:api_version/sold_to_accounts
Example Request Body
{
    "sold_to_account": {
        "account_number": "123",
        "address_1": "448 Test Street",
        "address_2": "",
        "alternate_name": "ATTN",
        "city": "Lawrence",
        "company_name": "",
        "country": "US",
        "first_name": "John",
        "last_name": "Doe",
        "phone": "(770) 210-4897",
        "postal_code": "66049",
        "ship_to_accounts": [
            {
                "account_number": "123_sh",
                "address_1": "448 Test Street",
                "address_2": "",
                "alternate_name": "ATTN",
                "city": "s",
                "company_name": "",
                "country": "US",
                "email": "test@test.com",
                "first_name": "John",
                "last_name": "Doe",
                "phone": "(770) 210-4897",
                "postal_code": "66049",
                "state_region": "KS"
            }
        ],
        "state_region": "KS"
    }
}

Request Body Schema

Field Name
Type
Required
Description

account_number

string

Yes

Unique identifier for the sold-to account

address_1

string

Yes

Primary address line

address_2

string

No

Secondary address line, can be empty

city

string

Yes

City name

country

string

Yes

Two-letter country code (ISO 3166-1 alpha-2)

postal_code

string

Yes

Postal/ZIP code

company_name

string

No

Business or company name, can be empty

first_name

string

Yes

Customer's first name

last_name

string

Yes

Customer's last name

phone

string

No

Phone number with optional formatting

ship_to_accounts

array

yes

this array can be empty. the array should contain objects

state_region

string

yes

State/province/region code

200 Successful response example

{
  "sold_to_account": {
    "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",
    "first_name": "John",
    "id": 12345,
    "last_name": "Doe",
    "phone": "(770) 210-4897",
    "postal_code": "66049",
    "ship_to_accounts": [
      {
        "account_number": "123_sh",
        "address_1": "448 Test Street",
        "address_2": "",
        "alternate_name": "ATTN",
        "city": "s",
        "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_region": "KS",
        "updated_at": "2022-10-31T01:54:56.271Z"
      }
    ],
    "state_region": "KS",
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}

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.

PreviousOverviewNextCreate a ship_to_account

Last updated 5 months ago