OMS DOCUMENTATIONRESOURCE CENTER

These guides provide examples for many tasks that a developer will need to be familiar with during implementation.

KIBO OMS DEVELOPMENT

Documentation

Get Customer Address

The Get Customer Address API returns the address details of a certain customer, if the Address ID is known. The Address ID is often part of the data returned by most Get Order and Get Shipment, designated within the data block for shipping address information.

However, it’s important to note that the IDs returned from those calls apply only to the particular shipment. The Customer Address API allows a customer’s usual address to be obtained without relying on a particular shipment. If the Address ID is not known, then an Address Search can be used instead with the Customer ID as a parameter.

Version2.0
Callhttps://integration.shopatron.com/api/v2/customerAddress/{addressID}
Supported FormatsJSON
HTTP MethodGET
Schemahttps://integration.shopatron.com/api/v2/schema/customerAddress.json

The .json address above can be used to access the schema within Postman. An example use of the Customer Address API follows below, or view the schema or the sample Postman collection.

Example

In this example, the customer details includes these particular properties:

  • Address ID 0123456
  • Both a valid billing and shipping address for Customer 000000

General Information

The response returns the following information about a customer address:

  • Identification (address ID, customer ID and names)
  • Contact Information (phone)
  • Street Address
  • Account Activity Flag (active, inactive, or frozen and fraudlock status)
  • Address Type (billing or shipping)

The Full Request

Using the URL format as outlined in the table above, the entire call is simple to put together. 

https://integration.shopatron.com/api/v2/customerAddress/0123456

The Full Response

This is the full response returned by the API.

{
 "addressID": "0123456",
 "customerID": "000000",
 "firstName": "test",
 "lastName": "customer",
 "addressLine1": "000 TEST LN",
 "phone": "0000000000",
 "city": "DALLAS",
 "state": "TX",
 "postalCode": "75201",
 "countryCode": "US",
 "fraudLock": false,
 "active": true,
 "latitude": 38.6329,
 "longitude": -119.826,
 "isBilling": true,
 "isShipping": true
}