Retailers represent B2B retail partners for the calling merchant. Retailer records can include fulfillment defaults, retailer-specific custom fields, EDI identifiers, ship-to locations, and routing-guide metadata.
retailer.list(filters, options, fields)Retrieve a paged list of Retailers for the calling merchant. Terminated Retailers are excluded unless a status filter is supplied or options.include_terminated is true.
Optional list of Retailer fields to return. Use nested fields such as identifiers, ship_to_locations, and routing_guides only when those child records are needed.
Return Value
An object with results, totalCount, and numPages. Each item in results contains Retailer properties.
Optional default shipping method identifier for future order-integration defaults.
array
Optional list of shipping method identifiers allowed when this Retailer is selected.
integer
Optional default shipping third-party billing group ID for future order-integration defaults.
string
Optional routing-guide notes.
object
Optional Retailer custom-field values keyed by custom-field code. Hidden custom fields are omitted. Currency custom fields include the merchant/global default currency. Use Retailer Custom Fields to retrieve field definitions.
Identifier qualifier. Common values include duns, gln, mutually_defined, and custom.
string
Identifier value.
string
Optional display label.
string
Optional notes.
string
The creation timestamp in ISO 8601 format.
string
The last update timestamp in ISO 8601 format.
Retailer Ship-To Location Properties
Show Retailer Ship-To Location Properties
integer
An automatically generated ship-to location row ID.
string
required
Retailer-assigned ship-to location code.
string
required
The canonical scheme that identifies the location code. EDI qualifiers are normalized to this set. Allowed values: duns, duns_plus_4, gln, buyer_location, seller_location, third_party_location, plant_code, dodaac, cage, dea, hin, san, approver_id, clli, census_schedule_d, census_schedule_k.