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

Create Location

The Location API allows a fulfillment location to be created with basic location data. This includes the address, primary contact information, and fulfillment options such as whether the location is enabled for pickup or has a storefront.

Version2.0
Callhttps://integration.shopatron.com/api/v2/location/
Supported FormatsJSON
HTTP MethodPOST
Schemahttps://integration.shopatron.com/api/v2/schema/location.json

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

Example

This example case creates a location based on the following characteristics:

  • Location name is “TEST LOCATION”
  • Taxable shipping location in Dallas

This guide will demonstrate how to put together each section of the request.

Required Parameters

The following are required for all instances of this call:

ParameterTypeDescription
namestringThe name of the location. The minimum length is 1 and the maximum length is 50.
addressLine1stringThe first line of the street address. The minimum length is 1 and the maximum length is 50.
citystringThe city that the street address is located in. The minimum length is 1 and the maximum length is 50.
countryCodeenumThe code indicating the country that the address is location in (e.g. US, AD, etc.).
phonestringThe phone number of the location. The minimum length is 1 and the maximum length is 20.
localSalesTaxnumberThe local sales tax of the location.
activebooleanIndicates whether the location is active or not within the Kibo network.
shippingLocationbooleanIndicates whether the location can ship shipments.
taxableLocationbooleanIndicates whether the location is taxable.

Optional Parameters

These are the other details that can be used to create a location:

ParameterTypeDescription
locationIDintegerA unique identifier for the fulfillment location. The minimum value is “1”.
externalStoreIDstringA client-generated unique identifier for the location.
retailerIDintegerA unique identifier for the retailer.
manufacturerIDintegerA unique identifier for a manufacturer. The minimum value is “1”.
fulfillerIDintegerA unique identifier for a fulfiller. The minimum value is “1”.
addressLine2stringThe second line of the street address. The maximum length is 50.
addressLine3stringThe third line of the street address. The maximum length is 50.
stateenumThe state that the street address is located in (e.g. TX, CO).
postalCodestringThe postal code or zip code of the address. The minimum length is 1 and the maximum length is 35.
latitudenumberThe latitudinal value of the location.
longitudenumberThe longitudinal value of the location.
contactstringThe name of the location’s primary contact person.
contactPhonestringThe phone number of the location’s primary contact person. The minimum length is 1 and the maximum length is 20.
faxstringThe location’s preferred fax number. The maximum length is 20.
emailstringThe location’s desired contact email address. The maximum length is 50.
restockEnabledbooleanIndicates whether the location can be restocked by its distribution center.
pickupEnabledbooleanIndicates whether shipments can be picked up at the location.
showInAggregateReportbooleanIndicates whether the location shows up in the aggregate report.
hasStorefrontbooleanIndicates whether the location has a storefront that customers can walk into.
assemblybooleanIndicates if the location offers assembly services, in which items are put together for the client on request.
deliverybooleanIndicates if the location offers employee delivery of an order to the customer’s address.
mainLocationbooleanIndicates whether the location is the fulfiller’s primary location.
expressbooleanIndicates whether the requesting retailer is able to express ship for the given catalog.
lastUpdatedstring (date-time)The date that this location was last updated.

The Full Request

This is the entire request that will create a new location.

{
 "manufacturerID": 11111,
 "fulfillerID": 22222,
 "name":"TEST LOCATION",
 "addressLine1": "000 Test St",
 "city": "Dallas",
 "countryCode": "US",
 "phone": "000-000-0000",
 "localSalesTax": 0.06075,
 "active": true,
 "shippingLocation": true,
 "taxableLocation": true
}

The Full Response

This is the entire response returned by the API. It will include a Kibo-assigned identifier for the location and other related information, including default values for any configurations that were not set.

{
 "locationID": 012345,
 "manufacturerID": 11111,
 "fulfillerID": 22222,
 "name": "TEST LOCATION",
 "addressLine1": "000 Test St",
 "city": "Dallas",
 "countryCode": "US",
 "contact": " ",
 "phone": "000-000-0000",
 "localSalesTax": 0.06075,
 "active": true,
 "shippingLocation": true,
 "restockEnabled": false,
 "pickupEnabled": false,
 "showInAggregateReport": false,
 "taxableLocation": true,
 "mainLocation": false,
 "lastUpdated": "2018-01-03T16:14:21+0000"
}