Ship-to Address API

Overview

The WMS Ship-to Address API is a Business Central API page designed to manage ship-to address data. This API allows external systems to interact with ship-to address records, providing functionality for creating, reading, and updating ship-to address information.

API Details

Publisher: smart
API Group: wms
API Version: v2.0
Entity Name: shipToAddress
Entity Set Name: shipToAddresses
Source Table: Ship-to Address
ODataKeyFields: Customer No., Code

Fields

The following fields are exposed in the API:

Field Name	Source Field	Required	Description
`CustomerNo`	`Ship-to Address."Customer No."`	Yes	Customer number associated with the address.
`Code`	`Ship-to Address."Code"`	Yes	Unique code for the ship-to address.
`Address`	`Ship-to Address.Address`	No	Primary address line.
`Address2`	`Ship-to Address."Address 2"`	No	Secondary address line.
`City`	`Ship-to Address.City`	No	City of the ship-to address.
`Contact`	`Ship-to Address.Contact`	No	Contact person for the ship-to address.
`PhoneNo`	`Ship-to Address."Phone No."`	No	Phone number associated with the address.
`ShippingAgentCode`	`Ship-to Address."Shipping Agent Code"`	No	Code of the shipping agent.
`LocationCode`	`Ship-to Address."Location Code"`	No	Location code for the address.
`PostCode`	`Ship-to Address."Post Code"`	No	Postal code of the address.
`County`	`Ship-to Address.County`	No	County of the address.
`EMail`	`Ship-to Address."E-Mail"`	No	Email address associated with the contact.
`ShippingAgentServiceCode`	`Ship-to Address."Shipping Agent Service Code"`	No	Service code of the shipping agent.
`ServiceZoneCode`	`Ship-to Address."Service Zone Code"`	No	Service zone code for the address.
`Longitude`	`Ship-to Address."SMA Longitude"`	No	Longitude of the address.
`Latitude`	`Ship-to Address."SMA Latitude"`	No	Latitude of the address.
`DeliveryZoneCode`	`Ship-to Address."SMA Delivery Zone Code"`	No	Delivery zone code for the address.

Example Usage

Create a New Ship-to Address

POST host/instance/api/smart/wms/v2.0/companies(companyId)/shipToAddresses
Content-Type: application/json

{
    "CustomerNo": "CUST001",
    "Code": "ADDR001",
    "Address": "123 Main Street",
    "City": "Sample City",
    "PostCode": "12345"
}

Retrieve a Ship-to Address

GET host/instance/api/smart/wms/v2.0/companies(companyId)/shipToAddresses('CUST001','ADDR001')

Update a Ship-to Address

PATCH host/instance/api/smart/wms/v2.0/companies(companyId)/shipToAddresses('CUST001','ADDR001')
Content-Type: application/json

{
    "Address": "456 Updated Street",
    "City": "Updated City"
}

Table of Contents