Data objects

Important

This integration guide supports physical goods. The physical goods product category is in Early Availability status. Features in Early Availability status are only available in production to a limited number of customers based on fit with specific use cases. For more information about Early Availability status, see Product lifecycle phases. If you would like to use the product capabilities described here during the Early Availability phase, contact your AppDirect technical representative.

The physical fulfillment manager expects the shipping connector to understand the data objects described in this topic. These objects define how an entity is presented to the shipping connector. In addition, when the shipping connector returns a response that contains any of these data objects, it needs to verify that all fields have been populated correctly.

Address object

This object depicts how the address is represented, in a format that AppDirect can understand.

Attribute	Type	Required	Definition
name	String	N	Customer name
company	String	N	Company name
addressLine1	String	Y	Street address
addressLine2	String	N	Optional second street address
city	String	Y	City
subdivisionCode	String	Y	State or province code (2-character, for example, CA or NY)
postalCode	String	Y	Zip or postal code
countryCode	String	Y	ISO 3166 alpha-2 country code
phone	String	N	Customer phone number
email	String	N	Customer email

Item object

This object depicts how an item is represented, in a format that AppDirect can understand.

Attribute	Type	Required	Definition
fulfillmentItemId	String	Y	The item identifier referenced within AppDirect
quantity	Number	Y	The quantity of the item
configuration	Object	Y	The item dimension details, or the SKU reference for a dropshipment item. Please refer to the “Item configuration object (Non-dropshipment item)” and “Item configuration object (Non-dropshipment item)” definitions below

Item configuration object (non-dropshipment)

note

Although the marketplace currently does not track item attributes (dimensions and weight), hard-coded default values are provided in this object. The purpose is to ensure future compatibility between the marketplace and the connector.

Attribute	Type	Required	Definition
length	Number	Y	Length of the parcel
width	Number	Y	Width of the parcel
height	Number	Y	Height of the parcel
lengthUnit	String	Y	Length of parcel (cm, in, ft, mm, m, yd)
weight	Number	Y	Weight of parcel
weightUnit	String	Y	Unit of weight (g, kg, oz, lb)

Item configuration object (dropshipment)

note

Since the item details exist within the dropshipment platform, only the SKU is required.

Attribute	Type	Required	Definition
sku	String	Y	The SKU reference of the item in the external dropshipment platform

Rate object

This object depicts how a shipping rate is represented, in a format that AppDirect can understand.

Attribute	Type	Required	Definition
shippingQuoteId	String	Y	Unique identifier of the rate
shippingRateId	String	Y	Unique identifier of the rate
shippingCostMethod	String	Y	The shipping cost method used by AppDirect to determine the shipping rate calculation method
name	Object	Y	The shipping provider name mapping object
name[locale]	String	Y	The name output for the given locale
serviceType	String	Y	The name of the shipping provider's service level (for example, UP translates to UPS Ground)
cost	Number	Y	Shipping cost
currency	String	Y	ISO 4217 currency code (for example, CAD, USD)
isFree	Boolean	Y	Flag that determines whether the user interface should show the actual cost value or a FREE label for each rate.