The RyderShip API is used to map required GS1 label fields for each retailer so data passes correctly. RyderShip also supports a legacy method, which is no longer used for new setups.
Retailer mapping requirements are detailed below.
For more information on RyderShip’s GSI label process and requirements, see GS1 Label Overview.
Required steps before using a template
Important! Each template must be approved by the retailer to ensure the label setup is correct before you start using the template.
Key items to remember:
- The order dropped into the RyderShip Sandbox must have data that mimics a Production order to ensure accurate testing.
- The test label must be printed at a workstation at the customer’s designated warehouse.
- Once the retailer approves, then the template is ready to use.
- Use this approval process for each individual retailer using a GS1 label.
GS1 field setup via RyderShip API
With this method, you’ll use the RyderShip API to set up required GS1 label fields for each retailer. This is RyderShip’s method for all future GS1 setups.
Fields at the order and order item levels for each retailer must be set up appropriately to produce compliant GS1s. Data requirements for each retailer vary – see below for the specific requirements.
Important setup note: You must nest the content using the following nested style:
wholesale_attributes: { }
Order level code example:
Order Item level code example:
Altar'd State required mappings
| Data element to map | Altar'd State required? | Field to map to |
|---|---|---|
| Order level | ||
| Distribution Center (DC#) |
Required: ONLY when shipping to a DC |
{{order.wholesale_attributes.distribution_center}} |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store |
Required: ONLY when Store pack |
{{order.wholesale_attributes.store}} |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| Item Color | {{order.order_items_attributes.wholesale_item_attributes.item_color}} | |
| Item Size | {{order.order_items_attributes.wholesale_item_attributes.item_size}} | |
| Item Style | {{order.order_items_attributes.wholesale_item_attributes.style}} | |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Belk required mappings
| Data element to map | Belk required? | Field to map to |
|---|---|---|
| Order level | ||
| Distribution Center (DC#) | {{order.wholesale_attributes.distribution_center}} | |
| Department | {{order.wholesale_attributes.department}} | |
| Partner | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| FOB Code |
{{order.wholesale_attributes.fob_code}} Ex: Womens, Mens, Shoes |
|
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Bloomingdales required mappings
| Data element to map | Bloomingdales required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Vendor | {{order.wholesale_attributes.vendor_number}} | |
| Store Address | {{order.wholesale_attributes.store_address_attributes.address_1}} | |
| Store Address City | {{order.wholesale_attributes.store_address_attributes.city}} | |
| Store Address State | {{order.wholesale_attributes.store_address_attributes.state}} | |
| Store Address Zip | {{order.wholesale_attributes.store_address_attributes.zip}} | |
| Store Address Name | {{order.wholesale_attributes.store_address_attributes.name}} | |
| Replenishment |
{{order.wholesale_attributes.replenishment}} Pass the FOB Description from the EDI 850 |
|
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Blue Mercury required mappings
| Data element to map | Blue Mercury required? | Field to map to |
|---|---|---|
| Order level | ||
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store Number | {{order.wholesale_attributes.store}} | |
| Seller Name | {{order.wholesale_attributes.seller_name}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Dick's Sporting Goods required mappings
| Data element to map | DSG required? | Field to map to |
|---|---|---|
| Order level | ||
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Store Address | {{order.wholesale_attributes.store_address_attributes.address_1}} | |
| Store Address City | {{order.wholesale_attributes.store_address_attributes.city}} | |
| Store Address State | {{order.wholesale_attributes.store_address_attributes.state}} | |
| Store Address Zip | {{order.wholesale_attributes.store_address_attributes.zip}} | |
| Store Address Name | {{order.wholesale_attributes.store_address_attributes.name}} | |
| Sort Code | {{order.wholesale_attributes.sort_code}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| UPC |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes.upc}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Dillards required mappings
| Data element to map | Dillards required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Fanatics required mappings
| Data element to map | Fanatics required? | Field to map to |
|---|---|---|
| Order level | ||
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Holt Renfrew required mappings
| Data element to map | Holt Renfrew required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store Address | {{order.wholesale_attributes.store_address_attributes.address_1}} | |
| Store Address City | {{order.wholesale_attributes.store_address_attributes.city}} | |
| Store Address State | {{order.wholesale_attributes.store_address_attributes.state}} | |
| Store Address Zip | {{order.wholesale_attributes.store_address_attributes.zip}} | |
| Store Address Name | {{order.wholesale_attributes.store_address_attributes.name}} | |
| Class | {{order.wholesale_attributes.group}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Macys required mappings
| Data element to map | Macys required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Vendor | {{order.wholesale_attributes.vendor_number}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Store Address | {{order.wholesale_attributes.store_address_attributes.address_1}} | |
| Store Address City | {{order.wholesale_attributes.store_address_attributes.city}} | |
| Store Address State | {{order.wholesale_attributes.store_address_attributes.state}} | |
| Store Address Zip | {{order.wholesale_attributes.store_address_attributes.zip}} | |
| Store Address Name | {{order.wholesale_attributes.store_address_attributes.name}} | |
| Replenishment |
{{order.wholesale_attributes.replenishment}} Pass the FOB Description from the EDI 850 |
|
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Nordstrom | Nordstrom Rack required mappings
| Data element to map | Nordstrom required? | Field to map to |
|---|---|---|
| Order level | ||
| Distribution Center (DC#) | {{order.wholesale_attributes.distribution_center}} | |
| Department | {{order.wholesale_attributes.department}} | |
| Vendor | {{order.wholesale_attributes.vendor_number}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Saks required mappings
| Data element to map | Saks required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Group | {{order.wholesale_attributes.group}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Scheels required mappings
| Data element to map | Scheels required? | Field to map to |
|---|---|---|
| Order level | ||
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Location | {{order.wholesale_attributes.location}} | |
| CO (customer order) | Optional (CO or CR) |
{{order.wholesale_attributes.reference}} |
| CR (special order) | Optional (CO or CR) |
{{order.wholesale_attributes.reference}} |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| UPC |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes.upc}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Shopbop required mappings
| Data element to map | Shopbop required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| UPC |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes.upc}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Ulta required mappings
| Data element to map | Ulta required? | Field to map to |
|---|---|---|
| Order level | ||
| Distribution Center (DC#) | {{order.wholesale_attributes.distribution_center}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| Item Style | {{order.order_items_attributes.wholesale_item_attributes.style}} | |
| Item Description |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes.description}} |
| SKU |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes. alternate_sku}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
Von Maur required mappings
| Data element to map | Von Maur required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Store | {{order.wholesale_attributes.store}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
World Wide Golf required mappings
| Data element to map | World Wide Golf required? | Field to map to |
|---|---|---|
| Order level | ||
| Department | {{order.wholesale_attributes.department}} | |
| Wholesaler | Encouraged |
{{order.wholesale_attributes.partner}} Example: Shopbop |
| Purchase Order # | {{order.wholesale_attributes.po_number}} | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order item level | ||
| Item ID | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.item_id}} |
| Order Line # | eZCom orders only | {{order.order_items_attributes.wholesale_item_attributes.line_no}} |
| Item # |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes. alternate_item_number}} |
| Item Description |
Required when: Not required when: |
{{order.order_items_attributes.wholesale_item_attributes. description}} |
| EDI-required dates | ||
| Cancel Date | {{order.wholesale_attributes.cancel_date}} | |
| Start Date | {{order.wholesale_attributes.start_date}} | |
GS1 field setup using metafields (legacy)
The information below describes the RyderShip legacy metafields process for setting up GS1 label templates for retailers. Data requirements for each retailer vary – see below for the specific requirements.
This process is not used for any new setups.
Fields at the order and order item levels for each retailer must be set up appropriately for GS1 labels in RyderShip via a RyderShip API request.
With this method:
-
Order level fields are mapped in the
fieldsblock of the API request. -
Order item level fields are mapped in the
associated_fieldsblock of the API request.
For more details about the API request and metafields, see the API example in the eZCom Integration article.
Dillards required mappings
| Data element to map | Dillards required? | Metafield to map to |
|---|---|---|
| Order Level | ||
| Department | edi_department | |
| Purchase Order # | edi_po_number | |
| Store | edi_store | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order Item Level | ||
| Order Line # | edi_line_no | |
Nordstrom | Nordstrom Rack required mappings
| Data element to map | Nordstrom required? | Metafield to map to |
|---|---|---|
| Order Level | ||
| Distribution Center | edi_distribution_center | |
| Department | edi_department | |
| Vendor |
edi_vendor_number |
|
| Purchase Order # | edi_po_number | |
| Store | edi_store | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Item Level | ||
| Order Line # | edi_line_no | |
Von Maur required mappings
| Data element to map | Von Maur required? | Metafield to map to |
|---|---|---|
| Order Level | ||
| Department | edi_department | |
| Purchase Order # | edi_po_number | |
| Store | edi_store | |
| Customer Name | ||
| Shipping Name | ||
| Shipping Street 1 | ||
| Shipping Street 2 | ||
| Shipping City | ||
| Shipping State | ||
| Shipping ZIP | ||
| Order ID | ||
| Order Number | ||
| Order Item Level | ||
| Order Line # | edi_line_no | |
Related questions:
How do I set up the data for GS1 labels?