Overview
The list page that contains the Ship-to Addresses of customers. A customer can have several ship-to addresses, each identified by a code. The ship-to code can be used on sales documents to send the goods to another address than the customer's own address.
|
Endpoint name |
|
|
Source table |
|
|
Fixed view |
No filter. Returns the ship-to addresses of all customers. |
|
Requests allowed |
GET, POST, PATCH, DELETE |
|
Primary key |
“Customer No.”, “Code” |
|
Record ID |
|
|
Procedures |
None |
Creating, changing and deleting ship-to addresses
The API allows inserting, modifying and deleting entries. The same error handling applies as when the same is done within Business Central.
-
The customer in
customerNumbermust exist. -
When a new ship-to address is created, Business Central sets the Name to the name of the customer. A
namesent in the POST body is therefore replaced by the customer's name. To use another name, change it with a PATCH request after the ship-to address has been created. -
Only the most important fields are in the API. Other fields of the ship-to address (for example phone number, shipment method or location) are set up in Business Central.
The customers are available with the customers endpoint, see API - Customers.
Data
Field List
|
Property |
Type |
Format |
Description |
|
|
|
string |
uuid |
SystemId |
Record ID non-editable |
|
|
string |
max 20 |
Customer No. The customer must exist. |
primary key mandatory |
|
|
string |
max 10 |
Field “Code”, the code of the ship-to address. Unique per customer. |
primary key mandatory |
|
|
string |
max 100 |
Name. Set to the customer's name when the ship-to address is created (see Overview). |
optional |
|
|
string |
max 50 |
Name 2 |
optional |
|
|
string |
max 100 |
Address |
recommended |
|
|
string |
max 50 |
Address 2 |
optional |
|
|
string |
max 20 |
Post Code |
recommended |
|
|
string |
max 30 |
City |
recommended |
|
|
string |
max 30 |
Field “County” |
optional |
|
|
string |
max 10 |
Country/Region Code |
recommended |
|
|
string |
max 100 |
Contact |
optional |
|
|
string |
max 80 |
Email. Must be a valid email address. |
optional |
|
|
string |
max 20 |
Salesperson Code |
optional |
|
|
boolean |
|
Blocked (Wisefish field). Specifies if this ship-to address is blocked for shipping. |
optional |
|
|
integer |
|
System row version. Increments every time the record is modified. |
non-editable |
|
|
string |
date-time |
SystemModifiedAt (date and time of last change) |
non-editable |
Object Example
An example of one object:
{
"systemId": "3f6a2c18-8b4e-f011-b02a-8bca792786d1",
"customerNumber": "01121212",
"shipToCode": "WAREHOUSE",
"name": "Spotsmeyer's Furnishings",
"name2": "Central warehouse",
"addressLine1": "1200 NW 78th Avenue",
"addressLine2": "",
"postalCode": "US-FL 33126",
"city": "Miami",
"state": "FL",
"country": "US",
"contact": "Ms. Laura Diaz",
"email": "warehouse@example.com",
"salespersonCode": "OF",
"blocked": false,
"systemRowVersion": 2583117,
"lastModified": "2026-11-10T10:12:31.207Z"
}
Examples
Read ship-to addresses
Read the ship-to addresses of one customer
Reads all ship-to addresses of customer 01121212 with $filter. The response is a list of ship-to address objects, as shown in Object Example.
GET .../shipToAddresses?$filter=customerNumber eq '01121212'
Read one ship-to address
Reads one ship-to address by its Record ID (systemId).
GET .../shipToAddresses(3f6a2c18-8b4e-f011-b02a-8bca792786d1)
Read ship-to addresses that are not blocked
Reads the ship-to addresses of customer 01121212 that can be used for shipping, and returns only a few fields with $select.
Request:
GET .../shipToAddresses?$filter=customerNumber eq '01121212' and blocked eq false&$select=shipToCode,name,city,country
Response:
{
"@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/shipToAddresses(shipToCode,name,city,country)",
"value": [
{
"@odata.etag": "W/\"JzE5OzU1NjY3Nzg4OTkwMDExMjIzMzQ0OzAwOyc=\"",
"shipToCode": "WAREHOUSE",
"name": "Spotsmeyer's Furnishings",
"city": "Miami",
"country": "US"
}
]
}
Create, change and delete ship-to addresses
Insert a Ship-to Address
Creates the ship-to address STORE2 for customer 01121212. The name is set to the customer's name.
Request:
POST .../shipToAddresses
Body:
{
"customerNumber": "01121212",
"shipToCode": "STORE2",
"addressLine1": "45 Ocean Drive",
"postalCode": "US-FL 33139",
"city": "Miami Beach",
"state": "FL",
"country": "US",
"contact": "Mr. Paul Reed"
}
Response (shortened):
{
"@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/shipToAddresses/$entity",
"@odata.etag": "W/\"JzE5OzY2Nzc4ODk5MDAxMTIyMzM0NDU1OzAwOyc=\"",
"systemId": "7c1d9e42-a35f-f011-b02a-8bca792786d1",
"customerNumber": "01121212",
"shipToCode": "STORE2",
"name": "Spotsmeyer's Furnishings",
"addressLine1": "45 Ocean Drive",
"postalCode": "US-FL 33139",
"city": "Miami Beach",
"state": "FL",
"country": "US",
"contact": "Mr. Paul Reed",
"blocked": false,
"systemRowVersion": 2583140,
"lastModified": "2026-11-10T10:20:05.512Z"
}
Change a ship-to address
Changes the name of the new ship-to address. A PATCH request needs the If-Match header with the @odata.etag of the record (or *).
Request:
PATCH .../shipToAddresses(7c1d9e42-a35f-f011-b02a-8bca792786d1)
If-Match: *
Body:
{
"name": "Spotsmeyer's Beach Store"
}
Response (shortened):
{
"@odata.context": "https://containers.wisefish.com/BC/api/wisefish/base/v1.0/$metadata#companies(cf9f7b85-dd11-ef11-9f8b-6045bde9cc61)/shipToAddresses/$entity",
"@odata.etag": "W/\"JzE5Ojc3ODg5OTAwMTEyMjMzNDQ1NTY2OzAwOyc=\"",
"systemId": "7c1d9e42-a35f-f011-b02a-8bca792786d1",
"customerNumber": "01121212",
"shipToCode": "STORE2",
"name": "Spotsmeyer's Beach Store",
"systemRowVersion": 2583152,
"lastModified": "2026-11-10T10:24:48.090Z"
}
Block a ship-to address
Blocks the ship-to address for shipping.
PATCH .../shipToAddresses(7c1d9e42-a35f-f011-b02a-8bca792786d1)
If-Match: *
Body:
{
"blocked": true
}
Delete a ship-to address
Deletes the ship-to address. On success the response is empty (HTTP status 204 No Content).
DELETE .../shipToAddresses(7c1d9e42-a35f-f011-b02a-8bca792786d1)