Identifiers
Understanding the various identifiers is helpful for a successful integration. Below is an overview on each of the values and how they should be used.
Partner ID
Description: Dolly’s unique identifier for a given partner.
Determination: This identifier is determined by Dolly.
Requirement: Not required. Dolly obtains the Partner ID by referencing the auth token.
Purpose: The purpose of this identifier is to distinguish between partners within the Dolly system. Partners typically do not need to know or use their Partner ID because Dolly obtains the Partner ID by referencing the auth token.
Client ID
Description: The partner's unique identifier for a given client, or sub-entity.
Determination: This identifier is determined by a partner.
Requirement: Required.
Purpose: The purpose of this identifier is to distinguish between a partner’s sub-entities, if necessary.
Example: For example, a partner like “Nabisco” would have unique client IDs for “Oreos” and “Ritz Crackers”.
Notes: Client ID is only required to include in the body when creating a delivery. If a partner does not have any sub-entities, then the recommendation is to use a human-readable brand name that describes the partner, such as “Nabisco”.
External Order ID
Description: The partner's unique identifier for a given order.
Determination: This identifier is determined by a partner.
Requirement: Required.
Purpose: The purpose of this identifier is to match an order in a partner system with a delivery in Dolly’s system.
Notes: The combination of External Order ID and External Delivery ID must be unique.
External Delivery ID
Description: The partner's identifier for a given delivery.
Determination: This identifier is determined by a partner.
Requirement: Required.
Purpose: The purpose of this identifier is to match an delivery in a partner system with a delivery in Dolly’s system.
Example: For example, a customer at Big Appliance Warehouse Co. (BAWC) buys a washer and dryer. This generates one order for BAWC, but due to size and weight constraints requires two deliveries. In this case, BAWC would submit two delivery requests to the Dolly system, and this value is used to identify those deliveries in the partner system.
Notes: The combination of External Order ID and External Delivery ID must be unique. If a partner does not have unique identifiers for deliveries related to an order, then the recommendation is to simply use integers starting with the number one (1) for each delivery.
External Store ID
Description: The partner's unique identifier for the store dispensing a given delivery.
Determination: This identifier is determined by a partner.
Requirement: Required.
Purpose: The purpose of this identifier is to assist both the partner and Dolly with understanding the origin of a delivery.
To see example ID values and respective types, consult the Create Delivery REST API spec.
Updated about 1 year ago