For the complete documentation index, see llms.txt. This page is also available as Markdown.

Batch update sold_to_account

Method : POST

https://os.vucustom.com/api/v1/sold_to_accounts/bulk
Example Request Body
{
    "sold_to_accounts": [
        {
            "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

sold_to_accounts

array

Yes

This is an array of sold_to_account objects. please refer to schema for these objects.

if an object which is present in this array and not present in the DB it will get added.

if an object which is present in this array and also present in the DB it will get updated with the information provided.

An array of ship_to_account objects should be present for each sold_to account.

ship_to_accounts

array

Yes

This is an array of ship_to_account objects. please refer to schema for these objects. if an object which is present in this array and not present in the DB it will get added. if an object which is present in this array and also present in this array it will get updated with the information provided.

200 Successful response example

{
    "sold_to_accounts": [
        {
            "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"
        }
    ]
}

401 Unauthorized

The client doesn’t have correct authentication credentials.

403 Forbidden

The server is refusing to respond. This is typically caused by incorrect access.

404 Not Found

The requested resource was not found but could be available again in the future.

422 Unprocessable Entity

5xx Errors

An internal error occurred in VU Admin.

Last updated