Create a ship_to_account

Method : POST

https://admin.vucustom.com/api/:api_version/ship_to_accounts

Example Request Body

{
    "ship_to_account": {
        "account_number": "123",
        "address_1": "448 Test Street",
        "address_2": "",
        "alternate_name": "ATTN",
        "city": "Lawrence",
        "company_name": "",
        "country": "US",
        "email": "[e-mail]",
        "first_name": "John",
        "last_name": "Doe",
        "parent_account_number": "1234",
        "phone": "[phone]",
        "postal_code": "66049",
        "state_region": "KS"
    }
}

Request Body Schema

Field Name	Type	Required	Description
parent_account_number	string	yes	Required to add this object to a sold_to_account
account_number	string	Yes	Unique identifier for the sold-to account
first_name	string	Yes	Customer's first name
last_name	string	Yes	Customer's last name
alternate_name	string	No	Can be empty.
address_1	string	Yes	Primary address line
address_2	string	No	Secondary address line, can be empty
city	string	Yes	City name
state_region	string	yes	State/province/region code
postal_code	string	Yes	Postal/ZIP code
country	string	Yes	Two-letter country code (ISO 3166-1 alpha-2)
company_name	string	No	Business or company name, can be empty
phone	string	No	Phone number with optional formatting

200

200 Successful Response Example

{
  "ship_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",
    "email": "[e-mail]",
    "first_name": "John",
    "id": 12345,
    "last_name": "Doe",
    "phone": "[phone]",
    "postal_code": "66049",
    "sold_to_account_number": "123",
    "state_region": "KS",
    "updated_at": "2022-10-31T01:54:56.271Z"
  }
}

401

401 Unauthorized

The client doesn’t have correct authentication credentials.

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

422

422 Unprocessable Entity

5xx

5xx Errors

An internal error occurred in VU Admin.