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.
Methods Entity Properties Additional Resources retailer.listretailer.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.
Parameters Optional search filters. Supported fields: retailer_id, code, name, status, fulfillment_model, parent_retailer_id, created_at, and updated_at.
Optional search options . Supported options: sort_field, sort_dir, page, limit, and include_terminated. 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.
Example Request { "jsonrpc" : "2.0" , "id" : 1234 , "method" : "call" , "params" : [ "34aa989befe360d67fe3f70b3517a1e5" , "retailer.list" , [ { "status" : "active" }, { "sort_field" : "code" , "sort_dir" : "asc" , "limit" : 50 }, [ "retailer_id" , "code" , "name" , "status" , "fulfillment_model" ] ] ] }
Example Response { "jsonrpc" : "2.0" , "id" : 1234 , "result" : { "results" : [ { "retailer_id" : 123 , "code" : "walmart" , "name" : "Walmart" , "status" : "active" , "fulfillment_model" : "wholesale" } ], "totalCount" : 1 , "numPages" : 1 } }
retailer.inforetailer.info(code, fields)Retrieve one Retailer by its merchant-facing code. The lookup is scoped to the calling merchant.
Parameters Optional list of fields to return.
Return Value An object containing Retailer properties.
Example Request { "jsonrpc" : "2.0" , "id" : 1234 , "method" : "call" , "params" : [ "34aa989befe360d67fe3f70b3517a1e5" , "retailer.info" , [ "walmart" , [ "retailer_id" , "code" , "name" , "identifiers" , "ship_to_locations" , "routing_guides" ] ] ] }
Example Response { "jsonrpc" : "2.0" , "id" : 1234 , "result" : { "retailer_id" : 123 , "code" : "walmart" , "name" : "Walmart" , "identifiers" : [ { "identifier_id" : 456 , "qualifier" : "duns" , "qualifier_x12" : "01" , "value" : "123456789" , "label" : "Walmart DUNS" , "is_primary" : true , "notes" : null , "created_at" : "2026-05-28T12:00:00+00:00" , "updated_at" : "2026-05-28T12:00:00+00:00" } ], "ship_to_locations" : [ { "ship_to_location_id" : 789 , "code" : "DC01" , "location_type" : "dc" , "city" : "Bentonville" , "region" : "AR" , "country_id" : "US" , "is_default" : true , "status" : "active" } ], "routing_guides" : [ { "guide_id" : 987 , "title" : "Walmart Routing Guide" , "file_name" : "walmart-routing-guide.pdf" , "file_type" : "pdf" , "file_size" : 128000 , "uploaded_by" : "Organization User: Jane Manager" , "uploaded_at" : "2026-05-28T12:00:00+00:00" } ] } }
Entity Properties Retailer Properties An automatically generated Retailer identifier.
The merchant-facing Retailer code. Codes are unique within a merchant.
The Retailer display name.
Retailer lifecycle status. Allowed values: active, on_hold, terminated.
Default fulfillment model. Allowed values: wholesale, drop_ship, mixed.
Optional parent Retailer ID.
Optional parent Retailer code. Returned only when requested.
Optional legal Retailer name.
Optional doing-business-as name.
Optional default duties payor for future order-integration defaults. Allowed values: shipper, recipient, third_party.
Optional default shipping method identifier for future order-integration defaults.
Optional list of shipping method identifiers allowed when this Retailer is selected.
Optional default shipping third-party billing group ID for future order-integration defaults.
Optional routing-guide notes.
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. The creation timestamp in ISO 8601 format.
The last update timestamp in ISO 8601 format.
Retailer Identifier Properties Show Retailer Identifier Properties
An automatically generated identifier row ID.
Identifier qualifier. Common values include duns, gln, mutually_defined, and custom.
Optional X12 qualifier code.
Flag indicating the primary identifier for its qualifier.
The creation timestamp in ISO 8601 format.
The last update timestamp in ISO 8601 format.
Retailer Ship-To Location Properties Show Retailer Ship-To Location Properties
An automatically generated ship-to location row ID.
Retailer-assigned ship-to location code.
Optional X12 qualifier code.
Location type. Allowed values: dc, store, customer, other.
Optional ShipStream region ID.
Optional state or region value.
Optional ISO 3166-1 alpha-2 country code.
Optional telephone number.
Flag indicating the default ship-to location for the Retailer.
Ship-to location status. Allowed values: active, inactive.
The creation timestamp in ISO 8601 format.
The last update timestamp in ISO 8601 format.
Retailer Routing Guide Properties Show Retailer Routing Guide Properties
An automatically generated routing guide row ID.
Optional routing guide description.
The uploaded file extension or type.
Optional formatted Requester name for the uploader.
The upload timestamp in ISO 8601 format.
The creation timestamp in ISO 8601 format.
The last update timestamp in ISO 8601 format.
