Audience: Suppliers
The Rithum platform supports the following objects:
- Inventory
- Basic Catalog
- Order
- Order Cancel
- Order Status
- Shipment
- Invoice
- Return Create
- Return Update
- Return Cancel
- Return Complete
Note: The Basic Catalog Schema described below is not specific to a category and does not reflect any retailer rules or requirements. If your retail trading partner uses advanced catalog services and has unique requirements for each product category, see Advanced catalog services for suppliers for more information about advanced catalog services and Uploading your products for information about uploading products using advanced catalog templates.
Example Files
Download the attachment below for example templates for every data object.
File_Upload_Templates_2024-08-21
Table Definitions
|
Field Type |
Background Color |
Description |
| Required | Green | The field is required to be included for every record. |
| Recommended | Blue | The field is suggested to be included for every record, as the inclusion of this data is typically needed by most parties. |
| Optional | White/Grey | The field can be included if available. |
Data Type Definitions
|
Data Type |
Description | Example |
| String | A string can contain any set of characters. | ABC ThinkPad T410 |
| HTML | A string containing HTML markup. | The <strong>ABC ThinkPad T410 2516ADU Notebook</strong> is designed to enhance productivity and change the way that you work. |
| Integer | A whole number with no commas or decimal places. | 12 |
| Currency | A number that may contain up to 2 decimal places. No thousands separators or currency symbols are allowed. | 12.99 |
| Float | A number that may contain one or more decimal places. No thousands separators or currency symbols are allowed. | 49314.1247 |
| Bool | Boolean true or false value where '1' is 'true' and '0' is 'false'. | 1 |
| Date-Time | A ISO 8601 time-stamp in the following format: YYYY-MM-DDTHH:MM:SS±HH:MM | 2019-02-24T19:43:56+07:00 |
| Length-Unit | The unit of length. Length Unit options include: 'in', 'ft', 'm', 'cm', or 'mm'. | cm |
| Weight-Unit | The unit of weight. Weight unit options include: 'oz', 'g', 'lb', or 'kg'. | kg |
Fields starting with "dsco_" are fields that are generated by the platform. This allows Rithum to store inventory and order data across the platform. If these fields are provided on imports, they will be ignored, except for in certain circumstances relating to orders. In general, you can exclude these fields when generating your own version of these files.
It is recommended that retailers store the dsco_item_id and dsco_supplier_id in their systems, so that they can provide these within the Order file, to ensure that there is no problem finding the exact SKU being ordered.
Inventory Schema
|
Field Name |
Data Type |
Field Description | Example |
| sku | String | The SKU of the item. A limit of 70 characters is enforced. | SKU1234 |
| upc | String - UPC format enforced | The Universal Product Code (UPC). Must be either 6 (UPC-E) or 12 (UPC-A) digits. | 884942723438 |
| ean | String - EAN format enforced | The European Article Number. Must be either 8 or 13 digits. | 7321432654382 |
| mpn | String | The Manufacturer Part Number (MPN). | 28479UU |
| gtin | String | The Global Trade Item Number. Must be 8, 12, 13, or 14 digits. | 00012345678905 |
| isbn | String | The International Standard Book Number. Must be either 10 or 13 digits. | 1-84356-028-3 |
| partner_sku | String | Your partner's SKU. This field can be used when you only work with one trading partner. If you are connected to more than one trading partner, please use the partner_sku_map field to provide partner SKUs for all of your trading partners. | abc1234 |
| title | String | The title of the SKU. A common practice is to concatenate this data with other fields (such as manufacturer and brand) to end up with a more complete title (such as 'Thinkpad T100 Notebook'). | T100 Notebook |
| brand | String | The name of the brand. | ThinkPad |
| cost | Currency - No $ sign | The price of the SKU you are charging your retailers. When pricing tiers are used, this would be considered the default price. No thousands separators or currency signs are allowed. |
12.35 |
| currency_code | String | The 3-letter ISO 4217 currency code. | USD |
| allowed_retail_models | String | The types of retail models an item is eligible for sale on. Accepted values are: dropship, marketplace,wholesale. | dropship |
| listing_prices_usd | Currency | The listing price (in USD) that should be shown to the customer/end consumer of the product. | 45.55 |
| listing_prices_eur | Currency | The listing price (in EUR) that should be shown to the customer/end consumer of the product. | 45.55 |
| listing_prices_cad | Currency | The listing price (in CAD) that should be shown to the customer/end consumer of the product. | 45.55 |
| listing_prices_gbp | Currency | The listing price (in GBP) that should be shown to the customer/end consumer of the product. | 45.55 |
| quantity_available | Integer | The quantity available for order. The amount in the warehouse ready for shipment. If the exact quantity isn't know, use a value such as 100. | 45 |
| status | String | The status of the given SKU. Options allowed are 'in-stock', 'out-of-stock', or 'discontinued'. If 'in-stock' is provided the quantity_available must be greater than 0. If no status is available, then we will infer the status from the 'quantity_available' field. Status is required when updating an item to/from a 'discontinued' status. The status of the item will not change to/from 'discontinued' if this field is not included in the upload. | in-stock |
| unit_of_measure | string | The unit of measurement for a given quantity. Acceptable values: CA, EA, GR, IG, PK, PR, PL, SF, FT2, DZ, DZN, ST, SET |
EA |
| quantity_on_order | Integer | The quantity that has been ordered and is expected to be received in the future. To determine how much stock is available after the next shipment arrives (estimate_availability_date), add quantity_on_order to quantity_available. | 12 |
| estimated_availability_date | Date-Time | The date the SKU will be in stock. This is an estimation only. This field is only filled if quantity_available is less than or equal to 0. This is the date that the shipment of quantity_on_order products come in. | 2019-02-24T19:43:56+07:00 |
| warehouse_dsco_id_1 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_1 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity sets as required and increment the number at the end of the code/quantity set by one for each subsequent field set. |
WH01 |
| warehouse_retailer_code_1 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | 0 |
| warehouse_quantity_1 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, the quantity_available field must contain the total of all of the warehouse quantities provided. | 23 |
| warehouse_quantity_on_order_1 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_1 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| warehouse_dsco_id_2 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_2 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity/cost sets as required and increment the number at the end of the code/quantity/cost set by one for each subsequent field set. |
WH02 |
| warehouse_retailer_code_2 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | 0 |
| warehouse_quantity_2 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, the quantity_available field must contain the total of all of the warehouse quantities provided. | 23 |
| warehouse_quantity_on_order_2 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_2 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| warehouse_dsco_id_3 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_3 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity/cost sets as required and increment the number at the end of the code/quantity/cost set by one for each subsequent field set. |
WH03 |
| warehouse_retailer_code_3 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | 0 |
| warehouse_quantity_3 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, the quantity_available field must contain the total of all of the warehouse quantities provided. | 23 |
| warehouse_quantity_on_order_3 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_3 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| sales_cost_1 |
Float |
Sales cost of item | 2.25 |
| sales_price_1 |
Float |
Sales price of item | 4.50 |
| sales_start_date_1 |
Date-Time |
Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_1 |
Date-Time |
Sales end date | 2022-03-05T19:43:56+07:00 |
| sales_cost_2 |
Float |
Sales cost of item | 2.25 |
| sales_price_2 |
Float |
Sales price of item | 4.50 |
| sales_start_date_2 |
Date-Time |
Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_2 |
Date-Time |
Sales end date | 2022-03-05T19:43:56+07:00 |
| sales_cost_3 |
Float |
Sales cost of item | 2.25 |
| sales_price_3 |
Float |
Sales price of item | 4.50 |
| sales_start_date_3 |
Date-Time |
Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_3 |
Date-Time |
Sales end date | 2022-03-05T19:43:56+07:00 |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_product_id | Integer | The product_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_retailer_assortments | String | The assortments the SKU is assigned to within the platform in human-readable format. Suppliers cannot set the assortment as this is a feature that retailers have while organizing the products they have available to them. Multiple assortments should be separated by the double caret "^^". | Main^^Discount |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particular partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_create_date | Date-Time | The date that the SKU was originally created within the platform. | 2019-02-24T19:43:56+07:00 |
| dsco_last_quantity_update_date | Date-Time | The date that the SKU's quantity was last updated by the supplier. | 2019-02-24T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that we support. | 2019-02-24T19:43:56+07:00 |
Import File Naming Convention
When setting up a standard job, the name should match the following rules; however, you always have the option of specifying a different filename if needed:
- Start (prefix) with "Inventory_"
- If you are providing incremental updates, you should add a time stamp to your file after the prefix. If you always provide all SKUs in your inventory file, no change to the filename is needed.
- End in ".tab" for Tab delimited files, ".csv" for Comma delimited files, ".tsv" for Pipe delimited files and ".xls" for Excel files.
Example: Inventory_Daily_Update.tab
Export File Naming Convention
Inventory files that are exported from the platform will follow these file naming rules:
- Start (prefix) with "Inventory_".
- Next, we include the date and time in format "YYYYMMDDHHMMSS".
- End in ".xls" for Excel formatted files, ".tab" for Tab delimited files, ".csv" for Comma delimited files and ".tsv" for Pipe delimited files.
Example: Inventory_20150229134553.tab
While setting up the import or export job, you will have the option to specify a different filename if needed.
Basic Catalog Schema
|
Field Name |
Data Type |
Field Description |
Example |
| sku | String | The SKU of the item. This is the unique identifier that the supplier uses when orders are created. In some cases, UPC or MPN will be used as the SKU. A limit of 70 characters is enforced. | SKU1234 |
| upc | String - UPC format enforced | The Universal Product Code (UPC). Must be 6 (UPC-E) or 12 (UPC-A) digits. | 001234567890 |
| ean | String - EAN format enforced | The European Article Number. Must be 8 or 13 digits. | 8849427234389 |
| mpn | String | The Manufacturer Part Number (MPN). | TS-40 |
| gtin | String | The Global Trade Item Number. Must be 8, 12, 13 or 14 digits. | 00012345678905 |
| isbn | String | The International Standard Book Number (ISBN). Must be 10 or 13 digits. | 1-84356-028-3 |
| partner_sku | String | Your partner's SKU. This field can be used when you only work with one trading partner. If you are connected to more than one trading partner on the platform, please use the partner_sku_map field to provide partner SKUs for all of your trading partners. | abc1234 |
| title | String | The title of the SKU. A common practice is to concatenate this data with other fields (such as manufacturer and brand) to end up with a more complete title (such as 'Thinkpad T100 Notebook'). | T100 Notebook |
| brand | String | The name of the brand. | Brand Name |
| quantity_available | Integer | The quantity available for order. The amount in the warehouse ready for shipment. If the exact quantity isn't known, use a value such as 100. | 45 |
| status | String | The status of the given SKU. Options allowed are 'in-stock', 'out-of-stock', or 'discontinued'. If 'in-stock' is provided the quantity_available must be greater than 0. If no status is available, then we will infer the status from the 'quantity_available' field. Status is required when updating an item to/from a discontinued status. The status of the item will not change to/from discontinued if this field is not included in the upload. | in-stock |
| unit_of_measure | String | The unit of measurement for a given quantity. Acceptable values: CA, EA, GR, IG, PK, PR, PL, SF, FT2, DZ, DZN, ST, SET |
EA |
| quantity_on_order | Integer | The quantity that has been ordered and is expected to be received in the future. To determine how much stock will be available after the next shipment arrives (estimate_availability_date), add quantity_on_order to quantity_available. | 12 |
| estimated_availability_date | Date-Time | The date the SKU will be in stock. This is an estimation only. This field is only filled if quantity_available is less than or equal to 0. This is the date that the shipment of quantity_on_order products come in. | 2015-02-28T06:00:00-07:00 |
| warehouse_dsco_id_1 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_1 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity sets as required and increment the number at the end of the code/quantity set by one for each subsequent field set. |
WH01 |
| warehouse_quantity_1 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, quantity_available must contain the total of all of the warehouse quantities provided. | 54 |
| warehouse_retailer_code_1 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| warehouse_quantity_on_order_1 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_1 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| warehouse_dsco_id_2 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_2 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity sets as required and increment the number at the end of the code/quantity set by one for each subsequent field set. |
WH02 |
| warehouse_quantity_2 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, quantity_available must contain the total of all of the warehouse quantities provided. | 54 |
| warehouse_retailer_code_2 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| warehouse_quantity_on_order_2 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_2 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| warehouse_dsco_id_3 | String | This is an ID generated by the platform when a warehouse is created within the platform. | 0 |
| warehouse_code_3 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * The platform supports as many warehouse records as the supplier can provide. Simply include as many code/quantity sets as required and increment the number at the end of the code/quantity set by one for each subsequent field set. |
WH03 |
| warehouse_quantity_3 | Integer | The quantity available in the specified warehouse. When warehouse quantities are provided, quantity_available must contain the total of all of the warehouse quantities provided. | 54 |
| warehouse_retailer_code_3 | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| warehouse_quantity_on_order_3 | Integer | The quantity that has been ordered and is expected to be received in the future for this warehouse. | 54 |
| warehouse_estimated_availability_date_3 | Date-Time | The date the SKU will be in stock at this specific warehouse. This is the date that the shipment of warehouse_quantity_on_order_1 quantities come into the warehouse. | 2019-02-28T19:43:56+07:00 |
| min_purchase_quantity | Integer | The minimum quantity that must be ordered for the order to be accepted. | 1 |
| max_purchase_quantity | Integer | The maximum quantity that can be ordered that the supplier allows to be ordered. | 99 |
| product_group | String | A group identifier that, when multiple SKUs have the same product_group, the SKUs are options/variants of each other. For example, if 5 SKUs have the product_group of '123456', they are all children of the same parent SKU. This field is required whenever a parent-child relationship is defined. | If a variant: PARENT123 Otherwise: empty |
| product_title | String | The title of the given product that describes all of the various options/variants as a group. This field is suggested whenever a parent-child relationship is defined. | If a variant: T-Shirt Otherwise: empty |
| product_status | String | The status of the product within the product life cycle. The default status is 'pending' which informs their trading partners that they are setting up a new product. When the status changes to 'active', the trading partners are allowed to purchase the item. Possible values include: 'pending', 'active', 'discontinued_sell_through', 'discontinued'. Additional details on product status can be reviewed here. | active |
| product_availability_start_date | Date-Time | The date the item can start being ordered. The platform will automatically set the given item to 'active' on this date as long as all required fields are set appropriately. | 2019-02-24T19:43:56+07:00 |
| product_availability_end_date | Date-Time | The date the item can no longer be ordered. The platform will automatically set the given item to 'discontinued_sell_through' status on this date if positive quantity is available on the item or to 'discontinued' status if zero quantity is available. | 2019-02-24T19:43:56+07:00 |
| description | HTML | Full description that describes the SKU. HTML can be used although great care should be taken to ensure proper closing of any and all HTML tags. | The <strong>ThinkPad T100 2516ADU Notebook</strong> is designed to enhance productivity and change the way that you work. The ThinkPad T100 2516ADU Notebook features 2 GB of RAM and a 250 GB hard drive. |
| short_description | HTML | A shortened description of the SKU. HTML can be used although great care should be taken to ensure proper closing of any and all HTML tags. | Brand A <strong>ThinkPad 2516ADU T410 Notebook</strong> PC - Intel Core i5 520M 2.4 GHz Processor - 2 GB RAM - 250 GB Hard Drive - DVD+/-RW - 14.1-inch Display - 7 Professional - Black |
| long_text_description | String | A full text-only description of the SKU without the use of HTML or any other markup. Typically used for another medium (such as a point-of-sale system or mobile app). If long_description is also included, the content should be the same, other than markup. | The Brand A ThinkPad T410 2516ADU Notebook is designed to enhance productivity and change the way that you work. The Brand A ThinkPad T410 2516ADU Notebook features 2 GB of RAM and a 250 GB hard drive. |
| short_text_description | String | A shortened text-only description of the SKU without the use of HTML or any other markup. Typically used for another medium (such as a point-of-sale system or mobile app). If short_description is also included, the content should be the same, other than markup. | The Brand A ThinkPad T410 2516ADU Notebook is designed to enhance productivity and change the way that you work. |
| attribute_name_1 | String | The title of the attribute. Note that it is important that all suppliers use the same attribute titles to ensure that the retailer has a consistent set of attributes across suppliers. Possible attributes could include, but are not limited to: 'color', 'size', 'rating', 'genre', 'publisher', 'age_group', 'gender', 'material', 'pattern'. * The platform supports as many attributes as the supplier can provide. Simply include as many name and value sets as required and increment the number at the end of the name/reference pair by one for each subsequent field set. |
size |
| attribute_value_1 | String | The value of the attribute that is associated with the same attribute_name field pair. | XS |
| attribute_name_2 | String | The title of the second attribute. | color |
| attribute_value_2 | String | The value of the second attribute. | black |
| attribute_name_3 | String | The title of the third attribute. | gender |
| attribute_value_3 | String | The value of the third attribute. | female |
| size_primary_nrf_code | NRF Size Code | The primary size of the item matched to NRF's available Size Codes. | 10001 |
| size_primary_description | String | Human-readable description of the primary size of the item. | Large |
| size_secondary_nrf_code | NRF Size Code | The secondary size of the item matched to NRF's available Size Codes. | 35676 |
| size_secondary_description | String | Human-readable description of the secondary size of the item. | Wide |
| color_primary_nrf_code | NRF Color Code | The primary color of the item matched to NRF's available Color Codes. | 829 |
| color_primary_description | String | Human-readable description of the primary color. | Bright Orange/Orange Group |
| color_secondary_nrf_code | NRF Color Code | The secondary color of the item matched to NRF's available Color Codes. | 629 |
| color_secondary_description | String | Human-readable description of the secondary color. | Bright Red/Red Group |
| color_tertiary_nrf_code | NRF Color Code | The tertiary color of the item matched to NRF's available Color Codes. | 400 |
| color_tertiary_description | String | Human-readable description of the tertiary color. | Blue/Blue Group |
| details | String | Additional details not provided in the product description. In most cases, consider including this within the product description. | Here are some additional details about this SKU that we think are important for you to read. |
| warranty | String | Brief warranty description. | 90 day money back guarantee. |
| category | String | The category the SKU is assigned to in human-readable format. When providing category strings, each level of the category is separated by '|' with the top-level category being listed first and subsequent leaf categories being listed last. Only one category can be assigned per product. | Home and Garden|Lamps & Lighting|Table Lamps |
| assortments | String | The title of each assortment the SKU is assigned to with multiple assortments being separated by double caret "^^". | Main Assortment^^Spring 2015 |
| country_of_origin | String | The country of origin using the two-alpha-character ISO country code. | US |
| currency_code | String | The 3-letter ISO 4217 currency code. | USD |
| cost | Currency - No $ sign | The price of the SKU you are charging your retailers. When pricing tiers are used, this would be considered the default price. No thousands separators or currency signs are allowed. | 13.56 |
| msrp | Currency - No $ sign | The Manufacturer's Recommended Retail Price (MSRP). | 24.55 |
| map | Currency - No $ sign | The Minimum Advertised Price (MAP). | 17.99 |
| manufacture_cost | Currency - No $ sign | The supplier's cost of the item. This value is only shared with the platform, not to the supplier's trading partners. This allows the platform to provide profit reports to suppliers. | 56.12 |
| handling_cost | Currency - No $ sign | The handling costs or fees that will be added to the order when this SKU is purchased. | 2.00 |
| made_to_order_flag | Bool | Indicates whether the SKU must be manufactured or assembled at the time the supplier receives the order. Typically, this type of item will have a longer processing them and will take longer to ship than other items. | 1 |
| postal_carrier_service_flag | Bool | Indicates whether the SKU can be shipped via postal carriers such as USPS. Available options are '1' for True and '0' for False. | 1 |
| ground_carrier_service_flag | Bool | Indicates whether the SKU can be shipped via ground-level service using carriers that support ground methods, such as FedEx or UPS. Available options are '1' for True and '0' for False. | 1 |
| air_carrier_service_flag | Bool | Indicates whether the SKU can be shipped via air-level service using carriers that support air methods, such as FedEx or UPS. Available options are '1' for True and '0' for False. | 1 |
| freight_carrier_service_flag | Bool | Indicates whether the SKU can be shipped via freight-level service using carriers that support freight methods. Available options are '1' for True and '0' for False. | 1 |
| average_postal_carrier_service_cost | Currency - No $ sign | The average cost to ship the SKU via postal service carriers such as USPS. | 3.00 |
| average_ground_carrier_service_cost | Currency - No $ sign | The average cost to ship the SKU via ground-service carriers such as FedEx and UPS. | 5.00 |
| average_air_carrier_service_cost | Currency - No $ sign | The average cost to ship the SKU via air-service carriers such as FedEx and UPS. | 8.00 |
| average_freight_carrier_service_cost | Currency - No $ sign | The average cost to ship the SKU via freight service carriers. | 15.00 |
| ships_alone_flag | Bool | Must the SKU always be shipped by itself? '1' for True and '0' for False. | 1 |
| max_ship_single_box | Integer | Maximum number of this SKU that will fit in a single package. | 6 |
| min_business_days_to_ship | Integer | Minimum number of days supplier requires for fulfillment activity once order is received. | 0 |
| max_business_days_to_ship | Integer | Maximum number of days supplier requires for fulfillment activity once order is received. | 0 |
| department_id | String | Merchant's selling department | DPR123 |
| product_image_name_1 | String | The name of the product-level image, describing the content of the image. This is not a variant-level image. This would be the name of an image that represents the product as a whole and not a single variant or option-item. * The platform supports as many product_images as the supplier can provide. Simply include as many name and reference sets as required and increment the number at the end of the name/reference pair by one for each subsequent field set. |
Front View |
| product_image_reference_1 | String | The reference to the product-level image file. This could be a URL or a relative location if a local copy is available to the recipient. This would be an image that represents the product as a whole and not a single variant or option item. | http://www.sample.com/images/SKU1234.jpg |
| product_image_status_1 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
pending |
| product_image_mime_1 | String |
After an image is successfully processed, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe a jpeg image. |
image/jpeg |
| product_image_name_2 | String | The name of the second product-level image, describing the content of the image. This is not a variant-level image. This would be the name of an image that represents the product as a whole and not a single variant or option-item. | Side View |
| product_image_reference_2 | String | The reference to the product-level image file. This could be a URL or a relative location if a local copy is available to the recipient. This would be an image that represents the product as a whole and not a single variant or option-item. | http://www.sample.com/images/SKU1234.jpg |
| product_image_status_2 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
pending |
| product_image_mime_2 | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| product_image_name_3 | String | The name of the third product-level image, describing the content of the image. This is not a variant-level image. This would be the name of an image that represents the product as a whole and not a single variant or option-item. | Side View |
| product_image_reference_3 | String | The reference to the product-level image file. This could be a URL or a relative location if a local copy is available to the recipient. This would be an image that represents the product as a whole and not a single variant or option-item. | http://www.sample.com/images/SKU1234.jpg |
| product_image_status_3 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
pending |
| product_image_mime_3 | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| image_name_1 | String | The name of the image, describing the content of the image. * The platform supports as many images as the supplier can provide. Simply include as many name and reference sets as required and increment the number at the end of the name/reference pair by one for each subsequent field set. |
Front View |
| image_reference_1 | String | The reference to the image file. This could be a URL or a relative location if a local copy is available to the recipient. | http://www.sample.com/images/SKU1234.jpg |
| image_status_1 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
complete |
| image_mime_1 | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| image_name_2 | String | The name of the second image, describing the content of the image. | T410 Notebook - Side View |
| image_reference_2 | String | The reference to the image file. This could be a URL or a relative location if a local copy is available to the recipient. | http://www.sample.com/images/SKU1234.jpg |
| image_status_2 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
complete |
| image_mime_2 | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| image_name_3 | String | The name of the third image, describing the content of the image. | T410 Notebook - Rear View |
| image_reference_3 | String | The reference to the image file. This could be a URL or a relative location if a local copy is available to the recipient. | http://www.sample.com/images/SKU1234.jpg |
| image_status_3 | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
complete |
| image_mime_3 | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' |
image/jpeg |
| swatch_image_reference | String | The reference to the product-level swatch image file. This could be a URL or a relative location if a local copy is available to the recipient. This would be an image that represents the swatch for the product as a whole and not a single variant or option item. | http://www.sample.com/images/SKU1234.jpg |
| swatch_image_status | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
complete |
| swatch_image_mime | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: 'image/jpg', 'image/jpeg', 'image/png', 'image/gif' Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| brand_logo_image_reference | String | The reference to the brand image file. This could be a URL or a relative location if a local copy is available to the recipient. | http://www.sample.com/images/SKU1234.jpg |
| brand_logo_image_status | String |
The status of processing the image in question. Images processed before October 1, 2020 may not have a status and should be assumed to be complete. Enum: 'pending', 'complete', 'failed' pending: the image has been received from the supplier but has not yet been processed and many of the image's attributes will not be set yet. complete: the image has been successfully processed and all relevant attributes are now set on the image. failed: the image failed to process correctly and many of the image's attributes will not be set. |
complete |
| brand_logo_image_mime | String |
After an image is successfully processed after October 1, 2020, this will contain the original image's mime type. Enum: image/jpg, image/jpeg, image/png, image/gif Note that image/jpeg is preferred over image/jpg but that either could be used to describe an jpeg image. |
image/jpeg |
| weight | Float | The weight of the SKU. | 3.2 |
| weight_units | Weight-Unit | The unit of weight used with the 'weight' field. Possible values include: lb, oz, g, kg | enum[lb,oz,g,kg] |
| length | Float | The length of the SKU. | 3 |
| width | Float | The width of the SKU. | 5 |
| height | Float | The height of the SKU. | 4.25 |
| dimension_units | Length-Unit | The unit of length used with the dimension (length, height, depth) columns. Possible values include: in, ft, mm, cm, m | enum["in","ft","mm","cm","m"] |
| package_length | Float | The length of the package. | 9.4 |
| package_height | Float | The height of the package. | 8.4 |
| package_width | Float | The width of the package. | 5.4 |
| package_dimension_units | Length-Unit | Specifies the unit of measurement for the package dimensions. Possible values include: in, ft, mm, cm, m | enum["in","ft","mm","cm","m"] |
| package_weight | Float | The weight of the item when packaged for shipment. | 6.1 |
| package_weight_units | Weight-Unit | Specifies the unit of measurement for the Package Weight value. Possible values include: lb, oz, g, kg | enum["lb","oz","g","kg"] |
| condition | String | The condition of the SKU. Options may include, but are not limited to: 'New', 'Refurbished', 'Used'. | New |
| cross_sell_skus | String | Other SKUs that are similar to or sell well with this SKU. Separate SKUs with double carets '^^'. | SKU1234^^SKU12345 |
| accessory_skus | String | SKUs that are an accessory to the given SKU. Typically, these are SKUs that come from the same manufacturer that add additional functionality or accessibility to the given SKU. Separate SKUs with double carets '^^'. | SKU1234^^SKU12345 |
| purchased_together_skus | String | SKUs that are usually purchased together when this SKU is purchased. Separate SKUs with double carets '^^'. | SKU1234^^SKU12345 |
| keywords | String | Keywords associated with the given SKU, to be used for marketing purposes by the retailer. Separate key words with double carets '^^'. | shovel^^long handle |
| featured_sku_flag | Bool | Indicates that this SKU is featured by the supplier. '1' for True and '0' for False. | 1 |
| gift_wrap_available_flag | Bool | Is gift wrapping available for this SKU? '1' for True and '0' for False. | 1 |
| pers_available_flag | Bool | Is personalization available for this SKU? '1' for True and '0' for False. | 1 |
| pers_num_lines | Integer | If personalization is available, how many lines are supported? | 5 |
| pers_char_per_line | Integer | If personalization is available, how many characters are allowed per line? | 35 |
| pers_description | String | The description of the personalization that is available in human-readable format. | Embroidered with your name. Choose from blue, pink or yellow. Specify name up to 16 characters in addition to spaces. |
| pers_ship_lead_time | Integer | The unit for the lead time. If the lead time is '5 business days', the value for this column would be '5'. | 5 |
| pers_ship_lead_time_type | String | The description of the lead time. If the lead time is '5 business days', the value for this column would be 'business days'. Options include, but are not limited to: 'days', 'business days', 'weeks', 'months', 'hours' | business days |
| hazmat_flag | Bool | Does the item contain hazardous materials? | 1 |
| hazmat_class_code | String | If the item contains hazardous materials, what is the governing body's code that matches the item in question? | 1046 |
| hazmat_description | String | Human-readable description of the hazardous material within the item. | NA1463II |
| commission_percentage | Float | The percentage the supplier has set for the given trading partner to calculate the commission amount for an item when sold. | 8.5 |
| commission_amount | Currency - No $ sign | The monetary amount the retailer will pay to the supplier when purchasing the item. Calculated as MSRP x Commission Percentage. | 5.23 |
| locations_can_be_sold_country_1 |
String |
The country that an item can be sold in. Country is required if field is used. | USA |
| locations_can_be_sold_regions_1 |
String |
The region in the country that an item can be sold in. | OH |
|
locations_can_be_sold_postal_codes_1 |
String |
The postal code in the region within the country that an item can be sold in. | 31907 |
| locations_can_be_sold_country_2 |
String |
The country that an item can be sold in. Country is required if field is used. | USA |
| locations_can_be_sold_regions_2 |
String |
The region in the country that an item can be sold in. | NY |
|
locations_can_be_sold_postal_codes_2 |
String |
The postal code in the region within the country that an item can be sold in. | 10001 |
| locations_can_be_sold_country_3 |
String |
The country that an item can be sold in. Country is required if field is used. | USA |
| locations_can_be_sold_regions_3 |
String |
The region in the country that an item can be sold in. | CA |
|
locations_can_be_sold_postal_codes_3 |
String |
The postal code in the region within the country that an item can be sold in. | 11111 |
| locations_cannot_be_sold_country_1 |
String |
The country that an item CANNOT be sold in. Country is required if field is used. | USA |
| locations_cannot_be_sold_regions_1 | String | The region in the country that an item CANNOT be sold in. | CA |
| locations_cannot_be_sold_postal_codes_1 |
String |
The postal code in the region within the country that an item CANNOT be sold in. | 11111 |
| locations_cannot_be_sold_country_2 |
String |
The country that an item CANNOT be sold in. Country is required if field is used. | USA |
| locations_cannot_be_sold_regions_2 | String | The region in the country that an item CANNOT be sold in. | NY |
| locations_cannot_be_sold_postal_codes_2 |
String |
The postal code in the region within the country that an item CANNOT be sold in. | 10001 |
| locations_cannot_be_sold_country_3 |
String |
The country that an item CANNOT be sold in. Country is required if field is used. | USA |
| locations_cannot_be_sold_regions_3 | String | The region in the country that an item CANNOT be sold in. | GA |
| locations_cannot_be_sold_postal_codes_3 |
String |
The postal code in the region within the country that an item CANNOT be sold in. | 30107 |
| sales_cost_1 | Float | Sales cost of item | 2.25 |
| sales_price_1 | Float | Sales price of item | 4.50 |
| sales_start_date_1 | Date-Time | Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_1 | Date-Time | Sales end date | 2022-02-28T19:43:56+07:00 |
| sales_cost_2 | Float | Sales cost of item | 2.25 |
| sales_price_2 | Float | Sales price of item | 4.50 |
| sales_start_date_2 | Date-Time | Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_2 | Date-Time | Sales end date | 2022-02-28T19:43:56+07:00 |
| sales_cost_3 | Float | Sales cost of item | 2.25 |
| sales_price_3 | Float | Sales price of item | 4.50 |
| sales_start_date_3 | Date-Time | Sales start date | 2022-02-28T19:43:56+07:00 |
| sales_end_date_3 | Date-Time | Sales end date | 2022-02-28T19:43:56+07:00 |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_product_id | Integer | The product_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_retailer_assortments | String | The assortments the SKU is assigned to within the platform in human-readable format. Suppliers cannot set the assortment as this is a feature that retailers have while organizing the products they have available to them. Multiple assortments should be separated by the double caret "^^". | Main^^Discount |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particular partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_create_date | Date-Time | The date that the SKU was originally created in the platform . | 2015-02-28T06:00:00-07:00 |
| dsco_last_quantity_update_date | Date-Time | The date that the SKU's quantity was last updated by the supplier. | 2015-02-28T06:00:00-07:00 |
| dsco_last_cost_update_date | Date-Time | The date that the SKU's cost was last updated by the supplier. | 2015-02-28T06:00:00-07:00 |
| dsco_last_product_status_update_date | Date-Time | The timestamp of when the platform detected a change in the product status value on the given item. | 2019-02-28T06:00:00-07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that's support. | 2015-02-28T06:00:00-07:00 |
Import File Naming Convention
When setting up a standard job, the name should match the following rules although you always have the option of specifying a different filename if needed:
- Start (prefix) with "Product_".
- If you are providing incremental updates, you should add some kind of time stamp to your file after the prefix. If you always provide all SKUs in your inventory file, no change to the filename is needed.
- End in ".tab" for Tab delimited files, ".csv" for Comma delimited files, ".tsv" for Pipe delimited files, and ".xls" for Excel files.
Example: Catalog_Weekly_Update.tab
Export File Naming Convention
Product files that are exported from the platform will follow these file naming rules:
- Start (prefix) with "Catalog_".
- Next, we include the date and time in format "YYYYMMDDHHMMSS".
- End in "xls" for Excel formatted files, ".tab" for Tab delimited files, ".csv" for Comma delimited files, and ".tsv" for Pipe delimited files.
Example: Catalog_20150229134553.tab
Order Schema
One of the options below must be included for an order to be created in the platform:
- retailer_ship_carrier & retailer_ship_method
- retailer_shipping_service_level_code
- expected_delivery_date
- required_delivery_date
In the schema below, all of those fields are listed as required. However, only one option from the list above needs to be included.
| Field Name | Data Type | Field Description | Example |
| po_number | String | The unique order identifier generated by the retailer's ordering system. | abc1234 |
| number_of_line_items | Integer | Total number of line items on the order. | 3 |
| line_item_line_number | Integer | Sequential number of the line item in the order. | 2 |
| line_item_sku | String Limited | The SKU being ordered. A limit of 70 characters is enforced. When ordering multiple SKUs that span suppliers, you must provide the dsco_supplier_id along with the line_item_sku in the following format: line_item_sku^^dsco_supplier_id | SKU1234 |
| line_item_upc | String - UPC format enforced | The Universal Product Code (UPC). Must be 6 (UPC-E) or 12 (UPC-A) digits. | 693212378432 |
| line_item_ean | String - EAN format enforced | The European Article Number (EAN). Must be 8 or 13 digits. | 9032847321238 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Must be 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_partner_sku | String | Partner SKU of the line item, if provided. Partner SKUs are used by retailers to map supplier SKUs to retailer SKUs. | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_2 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_3 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_quantity | Integer | The quantity being ordered. | 1 |
| line_item_title | String | The title of the SKU being ordered. If the option to create unknown SKUs is enabled, this title will be used as the new SKU's title. | SKU Title |
| line_item_color | String | The color of the line item. | Blue |
| line_item_size | String | The size of the line item. | Large |
| line_item_supplier_title |
String |
Supplier's title. |
Supplier's Title |
| line_item_supplier_color |
String |
The item color sent by the supplier for a given SKU. |
Blue |
| line_item_supplier_size |
String |
The size of the line item, sent by the supplier. |
Medium |
| line_item_weight |
Float |
The weight of the line item. |
2.5 |
| line_item_weight_units | String |
The unit of measure of the weight of the line item. |
KG |
| line_item_expected_cost | Currency - No $ sign | The cost that the retailer expects to pay for the given SKU. | 21.23 |
| line_item_expected_cost_adjustment_allowed | Bool | A boolean value (0 = false, 1 = true) indicating whether the retailer allows cost adjustments or not. | 0 |
| line_item_extended_expected_cost_total | Float | Consumer price times the quantity. | 63.69 |
| line_item_product_group | String | The product_group of the variant SKU being ordered. This represents the parent SKU of the item being ordered. | abc123 |
| line_item_expected_delevery_date | Date-Time |
When the customer expects to get the package - on or before for this specific line-item. Only use this if each line item has a different date. Otherwise, use the field at the order level. |
2019-02-28T19:43:56+07:00 |
| line_item_required_delivery_date | Date-Time | The package needs to arrive on this exact date, not before or after for this specific line item. Only use this if each line item has a different date. Otherwise, use the field at the order level. | 2019-02-28T19:43:56+07:00 |
| line_item_acknowledge_by_date | Date-Time | The date by which the order should be acknowledged for this specific line item. Only use this if each line item has a different date. Otherwise, use the field at the order level. | 2019-02-28T19:43:56+07:00 |
| line_item_cancel_after_date | Date-Time | The date and time that the order should be cancelled by the supplier if not shipped before this date-time for this specific line item. Only use this if each line item has a different date. Otherwise, use the field at the order level. | 2019-02-28T19:43:56+07:00 |
| line_item_ship_by_date | Date-Time | The date by which the package should be shipped for this specific line-item. Only use this if each line-item has a different date. Otherwise, use the field at the order-level. | 2019-02-28T19:43:56+07:00 |
| line_item_requested_ship_date | Date-Time | The date by which the package is requested to be shipped for this specific line item. Only use this if each line item has a different date. Otherwise, use the field at the order level. | 2019-02-28T19:43:56+07:00 |
| line_item_invoice_by_date | Date-Time | The date by which an invoice should be sent to the platform for this specific line item. Only use this if each line item has a different date. Otherwise, use the field at the order level. | 2019-02-28T19:43:56+07:00 |
| line_item_consumer_price | Currency - No $ sign | The price that the retailer charged their customer for the given SKU. | 24.95 |
| line_item_consumer_price_with_tax | Currency - No $ sign | Consumer price including tax | 10.88 |
| line_item_consumer_price_without_tax | Currency - No $ sign | Consumer price excluding tax | 10.00 |
| line_item_consumer_balance_due | Float | Remaining balance due by the consumer. | 5.95 |
| line_item_consumer_credit_amount_total | Float | The amount of credit the consumer has on the current item. | 5.95 |
| line_item_consumer_line_number | Float | The line number of the consumer's order. | 2 |
| line_item_personalization | String | Instructions for personalization. | Name “Frederick” to be embroidered on the left sleeve. |
| line_item_warehouse_code | String | Used in conjunction with the Catalog Object, which allows for quantities to be specified for multiple warehouses. If the retailer wishes for the supplier to ship from a specific warehouse, that specific warehouse's warehouse code should be specified using this field. Since this is a line_item level field, each line_item_sku being ordered can specify a warehouse_code. | 05-887 |
| line_item_warehouse_retailer_code | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| line_item_warehouse_dsco_id | String | This is an ID generated by the platform when a warehouse is created within the platform. | w5a735f8fb5484253102350 |
| line_item_receipt_id | String | Receipt ID for the line item. | 235235asdasdf |
| line_item_secondary_receipt_id | String | Secondary receipt ID for the line item. | 348923akdjdk |
| line_item_gift_flag | Bool | Indicates whether or not the line item should be treated as a gift. | 1 |
| line_item_gift_receipt_id | String | Gift receipt ID for the line item. | 235235asdasdf |
| line_item_gift_to_name | String | Name of the person receiving the gift. | Jane Doe |
| line_item_gift_from_name | String | Name of the person sending the gift. | John Doe |
| line_item_gift_message | String | Message from the giver to the receiver concerning the gift. | Happy Anniversary |
| line_item_retail_price | Float | Actual retail price of the line item. | 14.25 |
| line_item_shipping_surcharge | Float | Shipping surcharge price applied to the line item. | 2.53 |
| line_item_handling_amount | Float | Handling amount for the line item. | 4.95 |
| line_item_packing_slip_sku | String | SKU listed on the packing slip. | SKU12345 |
| line_item_packing_slip_message | String | Specific message to include on the packing slip for the line item. | Sample packing slip message. |
| line_item_packing_slip_title | String | Title on the packing slip. | Sample Packing Slip Title |
| line_item_packing_instructions | String | Specific packing instructions for the line item. | Please include our returns phone number. |
| line_item_returns_message | String | Specific returns message to be included with the line item. | Please return this item directly to the store. |
| line_item_ship_instructions | String | Specific shipping instructions for the line item. | Please place this package on the south side of the house. |
| line_item_message | String | Specific message supplied by the retailer concerning the line item. | This is an awesome item! Customers love it! |
| line_item_bogo_flag | Bool | Indicates whether the line item was part of a BOGO (buy one, get one) purchase. | true |
| line_item_bogo_instructions | String | Instructions to include when this line item was part of a BOGO (buy one, get one) purchase. | This item was part of a BOGO purchase. |
| line_item_tax_percentage_1 | Float | Tax percentage applied to the line item. | 6.5 |
| line_item_tax_type_code_1 | String | Type of tax applied to the line item. | T1 |
| line_item_tax_amount_1 | Float | Tax amount calculated on the line item. *The platform can support up to three line_item_tax_amount_x fields per line item. | 11.52 |
| line_item_tax_jurisdiction_qualifier_1 | Enum |
Tax jurisdiction qualifier on the tax applied to the line item. Enum: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex' *The platform can support up to three line_item_tax_jurisdiction_qualifier_x fields per line item. |
State or Province |
| line_item_tax_jurisdiction_1 | String | Tax jurisdiction for the tax applied to the line item. *The platform can support up to three line_item_tax_jurisdiction_x fields per line item. |
GST |
| line_item_tax_exempt_code_1 | Enum |
Tax exempt code for the line item. Enum:
|
No (Not Tax Exempt) |
| line_item_tax_registration_number_1 | String | Tax registration number for the line item. *The platform can support up to three line_item_tax_registration_number_x fields per line item. |
123456 |
| line_item_tax_description_1 | String | Description of the tax applied to the line item. *The platform can support up to three line_item_tax_description_x fields per line item. |
Tax description |
| line_item_tax_percentage_2 | Float | Tax percentage applied to the order. | 6.5 |
| line_item_tax_type_code_2 | String | Type of tax applied to the order. | T2 |
| line_item_tax_amount_2 | Float | Tax amount applied to the line item. *The platform can support up to three line_item_tax_amount_x fields per line item. |
11.52 |
| line_item_tax_jurisdiction_qualifier_2 | Enum |
Tax jurisdiction qualifier on the tax applied to the line item. Enum: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex' *The platform can support up to three line_item_tax_jurisdiction_qualifier_x fields per line item. |
State or Province |
| line_item_tax_jurisdiction_2 | String | Tax jurisdiction for the tax applied to the line item. *The platform can support up to three line_item_tax_jurisdiction_x fields per line item. |
GST |
| line_item_tax_exempt_code_2 | Enum |
Tax exempt code for the line item. Enum: *The platform can support up to three line_item_tax_exempt_code_x fields per line item. |
No (Not Tax Exempt) |
| line_item_tax_registration_number_2 | String | Tax registration number for the line item. *The platform can support up to three line_item_tax_registration_number_x fields per line item. |
123456 |
| line_item_tax_description_2 | String | Description of the tax applied to the line item. *The platform can support up to three line_item_tax_description_x fields per line item. |
Canada VAT-QST |
| line_item_tax_percentage_3 | Float | Tax percentage applied to the line item. | 6.5 |
| line_item_tax_type_code_3 | String | Type of tax applied to the line item. | T1 |
| line_item_tax_amount_3 | Float | Tax amount applied to the line item. *The platform can support up to three line_item_tax_amount_x fields per line item. |
13.29 |
| line_item_tax_jurisdiction_qualifier_3 | Enum |
Tax jurisdiction qualifier on the tax applied to the line item. Enum: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex' *The platform can support up to three line_item_tax_jurisdiction_qualifier_x fields per line item. |
State Defined |
| line_item_tax_jurisdiction_3 | String | Tax jurisdiction for the tax applied to the line item. *The platform can support up to three line_item_tax_jurisdiction_x fields per line item. |
GST |
| line_item_tax_exempt_code_3 | Enum |
Tax exempt code for the line item. 'No (Not Tax Exempt)', *The platform can support up to three line_item_tax_exempt_code_x fields per line item. |
No (Not Tax Exempt) |
| line_item_tax_registration_number_3 | String | Tax registration number for the line item. *The platform can support up to three line_item_tax_registration_number_x fields per line item. |
123456 |
| line_item_tax_description_3 | String | Description of the tax applied to the line item. *The platform can support up to three line_item_tax_description_x fields per line item. |
Tax description |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | ABC Products |
| line_item_unit_of_measure | Enum | Value to denote how this item is packaged. Options allowed are 'EA' (Each), 'PR' (Pair), 'CA' (Case), 'IG' (Inner Package), or 'PL' (Pallet). If not specified, 'EA' is assumed, but not auto-populated. | EA |
| line_item_taxable_amount_of_sale | Float | Indicates the sale amount that was taxable at the line-level. | 23.11 |
| line_item_amount_of_sales_tax_collected | Float | The amount of sales tax collected for the given line-item. | 3.99 |
| line_item_retailer_line_id | String | Retailer's line ID for line item. | ABC12345 |
| line_item_commission_percentage | Float | Indicates the commission percentage of the line item | 5.0 |
| line_item_cross_dock_location_name | String | Location name of the cross dock for the line item. | Acme |
| line_item_cross_dock_location_company | String | Company name of the cross dock for the line item. | Company Name INC |
| line_item_cross_dock_location_address_1 | String | Cross dock address line 1 for the given line item. *The platform can support up to three line_item_cross_dock_location_address_x fields per line item. |
25 Main St. |
| line_item_cross_dock_location_address_2 | String | Cross dock address line 2 for the given line item. *The platform can support up to three line_item_cross_dock_location_address_x fields per line item. |
# 220 |
| line_item_cross_dock_location_address_3 | String | Cross dock address line 3 for the given line item. *The platform can support up to three line_item_cross_dock_location_address_x fields per line item. |
Lot number 3 |
| line_item_cross_dock_location_city | String | City where cross dock is located. | Anyville |
| line_item_cross_dock_location_region | String | The state if in the US otherwise the region if outside | UT |
| line_item_cross_dock_location_postal | String | Postal code for the cross dock location. | 12345 |
| line_item_cross_dock_location_country | String | Country where the cross dock is located. | US |
| line_item_cross_dock_location_county | String | County where the cross dock is located. | Anyville |
| line_item_cross_dock_location_phone | String | Daytime phone number for the cross dock. | 555-555-1234 |
| line_item_cross_dock_location_night_phone | String | Night time phone number for the cross dock. | 555-555-5678 |
| line_item_cross_dock_location_customer_number | String | Number used by cross dock company to identify customer. | AB123456 |
| line_item_cross_dock_location_email | String | Email for the cross dock. | email@address.com |
| line_item_expected_cross_dock_delivery_date | Date-Time | The line level expected delivery date for the cross dock | 2019-02-28T19:43:56+07:00 |
| line_item_cross_dock_location_address_type | String | The line level address type of the cross dock location | Commercial |
| line_item_cross_dock_location_attention | String | The line level person to notify at a cross dock location | Frederick Von Giezer |
| line_item_cross_dock_location_code | String | The line level code for the cross dock location | A5 |
| line_item_cross_dock_location_store_number | String | The line level store number of the cross dock location | B1990 |
| line_item_cross_dock_address_type | String | The line level address type of the cross dock location | Commercial |
| delivery_method | String | The header level delivery method by which the order will be delivered | in_store_pickup |
| business_rule_code | String | The header level code defining specific business rules related to this order | NOPACK |
| estimated_ship_date | Date-Time | The header level estimated ship date of the order | 2019-02-28T19:43:56+07:00 |
| line_item_estimated_ship_date | Date-Time | The header level estimated ship date of the line item | 2019-02-28T19:43:56+07:00 |
| ship_address_2 | String | Address 2 line of the customer to whom the order is being shipped. | Apt. 2b |
| ship_address_3 | String | Address 3 line of the customer to whom the order is being shipped. | Flat number 7 |
| ship_address_type | Enum | Is the address a 'Residential' or 'Commercial' address? Only two options available: 'Residential' or 'Commercial' | Residential |
| ship_city | String | Shipping city of the customer to whom the order is being shipped. | Fakeville |
| ship_region | String | Shipping region of the customer to whom the order is being shipped. | GA |
| ship_postal | String | Shipping postal code of the customer to whom the order is being shipped. | 31907-4704 |
| ship_county | String | Shipping county of the customer to whom the order is being shipped. | Fakeville |
| ship_country | String | Shipping country of the customer to whom the order is being shipped using the two-character ISO country code. If no country is provided, the default is 'US'. | US |
| ship_phone | String | Phone number of the customer to whom the order is being shipped. | 1234567890 |
| ship_night_phone | String | Night time phone number of the customer to whom the order is being shipped. | 555-555-6789 |
| ship_customer_number | String | Customer number of the customer to whom the order is being shipped. | |
| ship_site_type | Enum | Site type of the location where the order is being shipped. Enum: 'customer', 'store', 'installer', 'access-point' |
customer |
| ship_email | String | Email address of the customer to whom the order is being shipped. | email@company.com |
| ship_store_number | String | Ship-Store Number | B12 |
| ship_carrier | String | The name of the carrier that is preferred to be used for this order. Options could include: FedEx, UPS, USPS. | UPS |
| ship_method | String | Shipping method requested. Only those options supported by the supplier will be supported. | UPS_3DS |
| shipping_service_level_code | String | Used in conjunction with ship_carrier and ship_method, this allows the retailer to pass their own code, or the code that the supplier is expecting, using a pre-defined code that is agreed to between the supplier and retailer. | G1 |
| shipping_account_number |
String | The shipping account number the retailer would like the supplier to use when shipping the items on this order. | abc123 |
| expected_delivery_date | Date-Time | When the customer expects to get the package - on or before. | 2019-02-24T19:43:56+07:00 |
| expected_cross_dock_delivery_date | Date-Time | The header level expected delivery date to cross dock | 2019-02-28T19:43:56+07:00 |
| cross_dock_location_address_1 | String | The header level cross dock location address 1 | 1896 North 978 West St |
| cross_dock_location_address_2 | String | The header level cross dock location address 2 | Gate 7 |
| cross_dock_location_address_3 | String | The header level cross dock location address 3 | Dock B |
| cross_dock_location_address_type | String | The header level cross dock location address type | Commercial |
| cross_dock_location_attention | String | The header level attention line at the cross dock location | Nicholas Schmidt |
| cross_dock_location_city | String | The header level cross dock location city | Cross City |
| cross_dock_location_company | String | The header level company of cross dock location | Cross Dock Company Inc |
| cross_dock_location_country | String | The header level country of cross dock location | United States |
| cross_dock_location_county | String | The header level county of cross dock location | Countyville |
| cross_dock_location_customer_number | String | The header level customer number of cross dock location | 01189998819991197253 |
| cross_dock_location_email | String | The header level email of cross dock location | crossdock@email.com |
| cross_dock_location_code | String | The header level code of cross dock location | B37 |
| cross_dock_location_name | String | The header level name of cross dock location | CrossDocker |
| cross_dock_location_night_phone | String | The header level night phone number of cross dock location | 999-999-9999 |
| cross_dock_location_phone | String | The header level day phone number of cross dock location | 555-555-5555 |
| cross_dock_location_postal | String | The header level postal code of cross dock location | 12110 |
| cross_dock_location_region | String | The header level region of cross dock location | US |
| cross_dock_location_store_number | String | The header level store number of cross dock location | 9173 |
| cross_dock_address_type | String | The header level address type of cross dock | Commercial |
| delivery_method | String | The header level delivery method by which the order will be delivered | in_store_pickup |
| business_rule_code | String | The header level code defining specific business rules related to this order | NOPACK or PACK |
| estimated_ship_date | Date-Time | The header level estimated ship date of the order | 2019-02-28T19:43:56+07:00 |
| line_item_estimated_ship_date | Date-Time | The header level estimated ship date of the line item | 2019-02-28T19:43:56+07:00 |
| line_item_estimated_ship_reason | String | The reason for which an order item is expected to ship outside of the program's SLA | On Order |
| line_item_current_lifecycle | String | Indicates the lifecycle status for each quantity of the line_item. Formate=Status::Quantity with multiple lifecycles separated by ^^ |
acknowledged::1^^cancelled::1 |
| packing_slip_email | String | Email contact information that needs to print on a packing slip. Typically represents email address that receiver of goods would use in case contents of shipment do not match packing slip documentation. | email@address.com |
| packing_slip_phone | String | Typically a Customer Service phone number | 555-555-1234 |
| packing_slip_template | String | Specific, pre-defined value that selects, for this order, one of several packing slip format options that are supported for the order issuer. | AB |
| returns_message | String | Message to include on the packing slip for return instructions. | Return to the store. |
| message | String | Message to your supplier concerning the order. | You are a valued supplier. |
| gift_flag | Bool | Indicates whether or not the order should be treated as a gift purchase. | true |
| gift_message | String | Message supplied by the customer concerning the gift in the order. | I hope you enjoy this awesome gift I sent you for your birthday. |
| gift_to_name | String | The name of the person receiving the order as a gift. | Frederick Von Geizer II |
| gift_from_name | String | The name of the person sending the order as gift. | Frederick Von Geizer III |
| receipt_id | String | Receipt ID of the order. | 134asd |
| secondary_receipt_id | String | An additional or alternate receipt_id | 256fgh |
| gift_receipt_id | String | Gift receipt ID for the order. | 2452322asdfg |
| order_total_amount | Currency - No $ sign | The total of the order. Typically this is the value the retailer wishes to have printed on packing slips. | 21.23 |
| extended_expected_cost_total | Float | Extended expected cost total | 19.55 |
| taxable_amount_of_sale | Float | Indicates the sale amount that was taxable. Sum of line-items. | 43.25 |
| amount_of_sales_tax_collected | Float | Sum of the line-item amount of sales tax collected. | 11.63 |
| shipping_surcharge | Float | Surcharge applied to ship the order. | 2.53 |
| tax_percentage_1 | Float | Percentage of tax applied to the order. | 6.5 |
| tax_type_code_1 | String | Type of tax applied to the order. | T1 |
| tax_amount_1 | Float | Tax amount applied to the order | 13.29 |
| tax_jurisdiction_qualifier_1 | Enum | Tax jurisdiction qualifier on the tax applied to the order. Enum: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex' *The platform can support up to three line_item_tax_jurisdiction_qualifier_x fields per order. |
State Defined |
| tax_jurisdiction_1 | String | Tax jurisdiction for the tax applied to the order. | GST |
| tax_exempt_code_1 | Enum |
Tax exempt code for the order. Enum: 'No (Not Tax Exempt)', |
No (Not Tax Exempt) |
| tax_registration_number_1 | String | Tax registration number for the order. | 123456 |
| tax_description_1 | String | Description of the tax applied to the order. | Tax description |
| tax_percentage_2 | Float | Percentage of tax applied to the order. *The platform can support up to three tax_percentage_x fields per order. | 6.5 |
| tax_type_code_2 | String | Type of tax applied to the order. *The platform can support up to three tax_type_code_x fields per order. | T1 |
| tax_amount_2 | Float | Tax amount applied to the order. *The platform can support up to three tax_amount_x fields per order. | 13.29 |
| tax_jurisdiction_qualifier_2 | Enum |
Tax jurisdiction qualifier on the tax applied to the order. Enum: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex' *The platform can support up to three tax_jurisdiction_qualifier_x fields per order. |
State Defined |
| tax_jurisdiction_2 | String | Tax jurisdiction for the tax applied to the order. *The platform can support up to three tax_jurisdiction_x fields per order. | GST |
| tax_exempt_code_2 | Enum |
Tax exempt code for the order. Enum: *The platform can support up to three tax_exempt_code_x fields per order. |
No (Not Tax Exempt) |
| tax_registration_number_2 | String | Tax registration number for the order. *The platform can support up to three tax_registration_number_x fields per order. | 123456 |
| tax_description_2 | String | Description of the tax applied to the order. *The platform can support up to three tax_description_x fields per order. | Tax description |
| tax_percentage_3 | Float | Percentage of tax applied to the order. *The platform can support up to three tax_percentage_x fields per order. | 6.5 |
| tax_type_code_3 | String | Type of tax applied to the order. *The platform can support up to three tax_type_code_x fields per order. | T1 |
| tax_amount_3 | Float | Tax amount applied to the order. *The platform can support up to three tax_amount_x fields per order. | 13.29 |
| tax_jurisdiction_qualifier_3 | Enum |
Tax jurisdiction qualifier on the tax applied to the order. Enum: 'Customer defined', *The platform can support up to three tax_jurisdiction_qualifier_x fields per order. |
State Defined |
| tax_jurisdiction_3 | String | Tax jurisdiction for the tax applied to the order. *The platform can support up to three tax_jurisdiction_x fields per order. | GST |
| tax_exempt_code_3 | Enum |
Tax exempt code for the order. Enum:' *The platform can support up to three tax_exempt_code_x fields per order. |
No (Not Tax Exempt) |
| tax_registration_number_3 | String | Tax registration number for the order. *The platform can support up to three tax_registration_number_x fields per order. | 123456 |
| tax_description_3 | String | Description of the tax applied to the order. *The platform can support up to three tax_description_x fields per order. | Tax description |
| coupon_amount_1 | Float | Discount amount applied by the coupon. *The platform can support up to three coupon_amount_x fields per line item. | 25.5 |
| coupon_percentage_1 | Float | Discount percentage applied by the coupon.. *The platform can support up to three coupon_amount_x fields per line item. | 6.54 |
| coupon_amount_2 | Float | Discount amount applied by the coupon.. *The platform can support up to three coupon_amount_x fields per line item. | 25.5 |
| coupon_percentage_2 | Float | Discount percentage applied by the coupon. *The platform can support up to three coupon_amount_x fields per line item. | 6.54 |
| coupon_amount_3 | Float | Discount amount applied by the coupon. *The platform can support up to three coupon_amount_x fields per line item. | 25.5 |
| coupon_percentage_3 | Float | Discount percentage applied by the coupon. *The platform can support up to three coupon_amount_x fields per line item. | 6.54 |
| payment_card_type_1 | String | Type of payment card used by the customer. *The platform can support up to three payment_card_type_x fields per line item. | VISA |
| payment_card_last_four_1 | String | Last 4 digits of the payment card. *The platform can support up to three payment_card_last_four_x fields per line item. | 3432 |
| payment_card_type_2 | String | Type of payment card used by the customer. *The platform can support up to three payment_card_type_x fields per line item. | VISA |
| payment_card_last_four_2 | String | Last 4 digits of the payment card. *The platform can support up to three payment_card_last_four_x fields per line item. | 3432 |
| payment_card_type_3 | String | Type of payment card used by the customer. *The platform can support up to three payment_card_type_x fields per line item. | VISA |
| payment_card_last_four_3 | String | Last 4 digits of the payment card. *The platform can support up to three payment_card_last_four_x fields per line item. | 3432 |
| bill_to_name | String | Full name of the customer to whom the order is being billed. Either this field or the bill_to_first_name and bill_to_last_name fields must be provided. | Frederick Von Geizer III |
| bill_to_attention | String | The bill-to attention name for the order. | Johnny Walker |
| bill_to_first_name | String | The bill-to first name for the order. | Frederick |
| bill_to_last_name | String | The bill-to last name for the order. | Von Geizer III |
| bill_to_company | String | The bill-to company for the order. | Gadget Inc. |
| bill_to_address_1 | String | The bill-to first address line of the order. | 123 North 321 West |
| bill_to_address_2 | String | The bill-to second address line of the order. | Suite 2B |
| bill_to_address_3 | String | Address 3 line of the customer to whom the order is being billed. | Flat number 7 |
| bill_to_address_type | Enum | Is the address a residential or commercial address? Only two options available: 'Residential' or 'Commercial' | Residential |
| bill_to_city | String | The bill-to city of the order. | Delta |
| bill_to_region | String | The bill-to region (state in the US) of the order. | UT |
| bill_to_postal | String | The bill-to zip code for the order. | 84790 |
| bill_to_country | String | The bill-to country for the order. | US |
| bill_to_phone | String | The bill-to phone number supplied by the customer. | 8018018014 |
| bill_to_email | String | The bill-to email address supplied by the customer. | email@sample.com |
| buyer_name | String | Full name of the buyer of the order. | Frederick Von Geizer III |
| buyer_attention | String | The buyer attention name for the order. | Johnny Walker |
| buyer_first_name | String | The buyer first name for the order. | Frederick |
| buyer_last_name | String | The buyer last name for the order. | Von Geizer III |
| buyer_company | String | The buyer company for the order. | Gadget Inc. |
| buyer_address_1 | String | The buyer first address line of the order. | 123 North 321 West |
| buyer_address_2 | String | The buyer second address line of the order. | Suite 2B |
| buyer_address_3 | String | The buyer third address line of the order. | Flat number 7 |
| buyer_address_type | Enum | Is the address a residential or commercial address? Only two options available: 'Residential' or 'Commercial' | Residential |
| buyer_city | String | The buyer city of the order. | Delta |
| buyer_region | String | The buyer region (state in the US) of the order. | UT |
| buyer_postal | String | The buyer zip code for the order. | 84790 |
| buyer_country | String | The buyer country for the order. | US |
| buyer_county | String | The buyer county for the order. | Orange |
| buyer_customer_number | String | The buyer internal ID for the customer. | 12345 |
| buyer_phone | String | The buyer phone number. | 8018018014 |
| buyer_night_phone | String | The buyer night time (not work) phone number. | 8018018014 |
| buyer_email | String | The buyer email address. | email@sample.com |
| buyer_tax_registration_number | String | The buyer tax registration number. | 67890 |
| customer_name | String | Full name of the customer of the order. | Frederick Von Geizer III |
| customer_company | String | The customer company for the order. | Gadget Inc. |
| customer_address_1 | String | The customer first address line of the order. | 123 North 321 West |
| customer_address_2 | String | The customer second address line of the order. | Suite 2B |
| customer_address_3 | String | The customer third address line of the order. | Flat number 7 |
| customer_city | String | The customer city of the order. | Delta |
| customer_region | String | The customer region (state in the US) of the order. | UT |
| customer_postal | String | The customer zip code for the order. | 84790 |
| customer_country | String | The customer country for the order. | US |
| customer_county | String | The customer county for the order. | Orange |
| customer_customer_number | String | The customer internal ID for themselves. | 12345 |
| customer_phone | String | The customer phone number. | 8018018014 |
| customer_night_phone | String | The customer night time (not work) phone number. | 8018018014 |
| customer_email | String | The customer email address. | email@sample.com |
| invoice_to_name | String | Full name of the invoice-to of the order. | Frederick Von Geizer III |
| invoice_to_company | String | The invoice-to company for the order. | Gadget Inc. |
| invoice_to_address_1 | String | The invoice-to first address line of the order. | 123 North 321 West |
| invoice_to_address_2 | String | The invoice-to second address line of the order. | Suite 2B |
| invoice_to_address_3 | String | The invoice-to third address line of the order. | Flat number 7 |
| invoice_to_city | String | The invoice-to city of the order. | Delta |
| invoice_to_region | String | The invoice-to region (state in the US) of the order. | UT |
| invoice_to_postal | String | The invoice-to zip code for the order. | 84790 |
| invoice_to_country | String | The invoice-to country for the order. | US |
| invoice_to_county | String | The invoice-to county for the order. | Orange |
| invoice_to_customer_number | String | The invoice-to's internal ID for the customer. | 12345 |
| invoice_to_phone | String | The invoice-to phone number. | 5555555555 |
| invoice_to_night_phone | String | The invoice-to night time (not work) phone number. | 5555555555 |
| invoice_to_email | String | The invoice-to email address. | email@sample.com |
| acknowledge_by_date | Date-Time | The date by which the order should be acknowledged. | 2019-02-28T19:43:56+07:00 |
| cancel_after_date | Date-time | The date and time that the order should be canceled by the supplier if not shipped before this date-time. | 2015-02-28T06:00:00-07:00 |
| ship_by_date | Date-Time | The date by which the package should be shipped. | 2019-02-28T19:43:56+07:00 |
| invoice_by_date | Date-Time | The date by which an invoice should be sent to the platform. | 2019-02-28T19:43:56+07:00 |
| issuer_division | Date-Time | The division within the retailer's company that issued the order. | Orders |
| dsco_ship_carrier | String | The shipping carrier, as calculated by the platform. The platform will determine the actual service level code used by reaching out directly to the carrier. | FedEx |
| dsco_ship_method | String | The shipping method, as calculated by the platform. The platform will determine the actual service level code used by reaching out directly to the carrier. | Ground |
| dsco_shipping_service_level_code | String | The shipping service level, as calculated by the platform. The platform will determine the actual service level code used by reaching out directly to the carrier. | FE2D |
| retailer_ship_carrier | String | The shipping carrier requested by the retailer. | UPS |
| retailer_ship_method | String | The shipping method requested by the retailer. | Overnight |
| retailer_shipping_service_level_code | String | The shipping service level requested by the retailer. | FE2D |
| dsco_order_id | Integer | The Order ID assigned by the platform for the given order within the platform. | 2315758 |
| dsco_order_status | String | The status of the order assigned by the platform. | Created |
| dsco_lifecycle | Enum |
Indicates the lifecycle status of the order. Enum: 'received', 'created', 'acknowledged', 'completed' Details provided here. |
created |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the platform. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the platform. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particual partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_create_date | Date-Time | The date that the SKU was originally created within the platform. | 2019-02-28T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that we support. | 2019-02-28T19:43:56+07:00 |
Import File Naming Convention
When setting up a standard job, the name should match the following rules. You always have the option of specifying a different filename, if needed:
- Start (prefix) with "Order_".
- Next, it is suggested that retailers provide a time stamp to ensure that order files are not overwritten by newer files before the system has a chance to import the existing files.
- End in ".tab" for Tab delimited files, ".csv" for Comma delimited files, ".tsv" for Pipe delimited files, and ".xls" for Excel files.
Example: Order_20150229145656.tab
Export File Naming Convention
Order files that are exported from the platform will follow these file naming rules:
- Start (prefix) with "Order_".
- Include the date and time in format "YYYYMMDDHHMMSS"
- End in ".xls" for Excel formatted files, ".tab" for Tab delimited files, ".csv" for Comma delimited files, and ".tsv" for Pipe delimited files.
Example: Order_20150229134553.tab
Order Cancel Schema
| Field Name | Data Type | Field Description | Example |
| po_number | String | The unique order identifier generated by the retailer's ordering system. | abc1234 |
| order_cancel_reason | String | The reason the order has been cancelled. | Item was out of stock |
| number_of_line_items | Integer | Total number of line-items included on the cancellation update. | 3 |
| line_item_line_number | Integer | Line-item line Number | 2 |
| line_item_sku | String Limited | The SKU being referenced by this update. A limit of 70 characters is enforced. | SKU1234 |
| line_item_upc | String - UPC format enforced | Line Item UPC. Must be 6 (UPC-E) or 12 (UPC-A) digits. | 438203798321 |
| line_item_ean | String - EAN format enforced | Line-Item EAN. Must be 8 or 13 digits. | 8490321480321 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Must be 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_mpn | String | Manufacturer Part Number | MPN-123-456 |
| line_item_partner_sku | String | A unique ID for this item - one of the IDs must be present. | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_2 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_3 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_status_quantity | Integer | The quantity of the status being updated. | 3 |
| line_item_cancelled_quantity | Integer | The quantity of the line item to be cancelled. | 3 |
| line_item_unit_of_measure | String | Unit of measure of the line item. | CM |
| line_item_original_order_quantity | Integer | Line Item Original Order Quantity | 3 |
| line_item_cancel_code | String - Predefined Rithum codes are documented but users may set up a mapping to use their own codes. | Indicates the reason code for why the order line item is being cancelled. Refer to the Order Cancel Mapping settings to customize the values you may use or view the current list of allowed codes. | CXSS |
| line_item_cancel_reason | String | The reason the line item has been cancelled. This could include reasons why the SKU was rejected, such as 'out-of-stock', 'restricted', 'duplicate' or it could indicate that the SKU is on backorder and will be shipped when new inventory is received. | out-of-stock |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | ABC Products |
| line_item_activity_transaction_date | Date-Time | Date of this transaction. | 2019-02-28T19:43:56+07:00 |
| line_item_activity_transaction_id | String | ID of this transaction. | 1234567 |
| line_item_current_lifecycle | String | Indicates the lifecycle status for each quantity of the line_item. Formate=Status::Quantity with multiple lifecycles separated by ^^ |
acknowledged::1^^cancelled::1 |
| supplier_order_number | String | Provided by suppliers; The unique identifier of the order within the supplier's order management system. | 123ABC |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. | 12345 |
| origin_system | String | Originating system of the cancel action. | System Name |
| dsco_order_id | Integer | The Order ID assigned by the platform for the given order within the platform. If this column is included in an export, po_number is not required. | 2315758 |
| dsco_order_status | String | The status of the order assigned by the platform. | Created |
| dsco_lifecycle | Enum |
Indicates the lifecycle status of the order. For more information, see Order Lifecycle. Enum: 'Received', 'Created', 'Acknowledged', 'Completed' |
Received |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the platform. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the platform. | ABC Electronics |
| dsco_trading_partner_id | Integer | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particular partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_create_date | Date-Time | The date that the SKU was originally created within the platform. | 2019-02-24T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that is supported. | 2019-02-24T19:43:56+07:00 |
Import File Naming Convention
When setting up a standard job, the name should match the following rules although you always have the option of specifying a different filename if needed:
- Start (prefix) with "Order_Cancel_".
- Next, it is suggested that retailers provide a time stamp to ensure that order files are not overwritten by newer files before the system has a chance to import the existing files.
- End in ".tab" for Tab delimited files, ".csv" for Comma delimited files, ".tsv" for Pipe delimited files, and ".xls" for Excel files.
Example: Order_Cancel_20150229145656.tab
Export File Naming Convention
Order Cancel files that are exported from the platform will follow these file naming rules:
- Start (prefix) with "Order_Cancel_".
- Include the date and time in format "YYYYMMDDHHMMSS".
- End in ".xls" for Excel files, ".tab" for Tab delimited files, ".csv" for Comma delimited files, and ".tsv" for Pipe delimited files.
Example: Order_Cancel_20150229134553.tab
| Field Name | Data Type | Field Description | Example |
| po_number | String | The unique order identifier generated by the retailer's ordering system. | abc1234 |
| estimated_ship_date | Date-Time | Estimate ship date of the order | 2019-02-28T19:43:56+07:00 |
| number_of_line_items | Integer | Total number of line items on the order. | 3 |
| line_item_line_number | Integer | Sequential number of the line item in the order. | 2 |
| line_item_sku | String Limited | The SKU ordered. A limit of 70 characters is enforced. When providing order statuses of multiple SKUs that span suppliers, you must provide the dsco_supplier_id along with the line_item_sku in the following format: line_item_sku^^dsco_supplier_id | SKU1234 |
| line_item_upc | String - UPC Format Enforced | The Universal Product Code (UPC). Field Limitations - UPC = 6 (UPC-E) or 12 (UPC-A) digits. | 693212378432 |
| line_item_ean | String - EAN Format Enforced | The European Article Number (EAN). Field Limitations - EAN = 8 or 13 digits. | 9032847321238 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Field Limitations - GTIN = 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_partner_sku | String | Partner SKU of the line item, if provided. Partner SKUs are used by retailers to map supplier SKUs to retailer SKUs. | abc1234 |
| line_item_title | String | The title of the SKU. | SKU Title |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_2 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_3 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_estimated_ship_date | Date-Time | Estimated ship date of the line item | 2019-02-28T19:43:56+07:00 |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | Lifetime Products |
| line_item_activity_transaction_date | Date-Time | Date of this transaction. | 2024-06-12T06:30:39-00:00 |
| line_item_activity_transaction_id | String | ID of this transaction. | 123456 |
| line_item_current_lifecycle | String | Indicates the lifecycle status for each quantity of the line-item. Format= Status::Quantity with multiple lifecycles separated by ^^ |
acknowledged::1^^cancelled::1 |
| supplier_order_number | String | The unique order identifier generated by the supplier's ordering system. | 30545 |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. | 123456 |
| origin_system | String | Originating system of the order | System Name |
| dsco_order_id | Integer | The Order ID assigned by the platform for the given Order within the platform. | 2315758 |
| dsco_order_status | String | The Status of the Order assigned by the platform. | Created |
| dsco_lifecycle | enum ["received", "created", "acknowledged", "completed"] | Indicates the lifecycle status of the order. Details provided in Support. | created |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the platform. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the platform. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particular partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_create_date | Date-Time | The date that the SKU was originally created within the platform. | 2019-02-28T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that we support. | 2019-02-28T19:43:56+07:00 |
Shipment Schema
| Field Name | Data Type | Field Description | Example |
| po_number | String | The unique order identifier generated by the retailer's ordering system. | abc1234 |
| package_tracking_number | String | The tracking number of the package as assigned by the carrier. | 1Z123456789 |
| package_ship_carrier | String | The carrier that is shipping the package. Either a carrier & method or a service_level_code are required. | FedEx |
| package_ship_method | String | The shipment method that the package was shipped. Either a carrier & method or a service_level_code are required. | Ground |
| shipping_service_level_code | String | Used in conjunction with ship_carrier and ship_method, this allows the retailer to pass their own code, or the code that the supplier is expecting, using a pre-defined code that is agreed to between the supplier and Retailer. Either a carrier & method or a service_level_code are required. | G1 |
| package_ship_cost | Currency - No $ sign | The cost to ship the package. | 14.50 |
| package_ship_date | Date-Time | The date that the given package shipped. | 2019-02-28T19:43:56+07:00 |
| package_weight | Float | The weight of the package. | 3.2 |
| package_weight_units | Enum | Unit of measurement for the weight of the package. The unit of weight used with the 'package_weight' field. Possible values include: 'lb', 'oz', 'g', 'kg' | lb |
| package_reference_number_qualifier | Enum | The reference number qualifier for this shipment. Possible values include: 'BM' for Bill of Lading Number, 'CN' for Carrier's Reference Number. | BM |
| package_transportation_method_code | Enum | The transportation method code assigned by the carrier for the shipped package. Possible values include: 'A' for Air, 'J' for Motor, 'R' for Rail, 'S' for Ocean/Ship. | A |
| package_unit_of_measurement_code | Enum | The unit of measurement code. Typically "EA" for "Each". "PR" for "Pair" is also acceptable. | EA |
| package_carrier_manifest_id | String | The Carrier Manifest ID as generated by the LTL carrier. | abc123 |
| package_sscc_barcode | String | Serial Shipping Container Code (SSCC) barcode of the package. This field is usually required when the package is being shipped to the retailer's store. | 00123356789067845678 |
| package_warehouse_code | String | The supplier's code for the warehouse from which the order shipped. | Warehouse1 |
| package_warehouse_retailer_code | String | The suppliers’ code for the warehouse from which the order shipped. | Warehouse1 |
| package_warehouse_dsco_id | String | The platform's internal code for the warehouse this shipped from. | w5a735f8fb5484253102350 |
| requested_warehouse_code | String | This is a value specified by a supplier to map to a specific warehouse. | Warehouse1 |
| requested_warehouse_retailer_code | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| requested_warehouse_dsco_id | String | This is an ID generated by the platform when a warehouse is created within the platform. | w5a735f8fb5484253102350 |
| dsco_warehouse_code | String | This is a recommendation based on Shipping Science. | Warehouse1 |
| dsco_warehouse_retailer_code | String | This is a recommendation based on Shipping Science. | Warehouse1 |
| dsco_warehouse_dsco_id | String | This is a recommendation based on Shipping Science. | w5a735f8fb5484253102350 |
| number_of_line_items | Integer | Total number of line-items included on the package update. | 3 |
| line_item_line_number | Integer | Line item number of the SKU on the order. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
2 |
| line_item_sku | String | The SKU being referenced by this update. A limit of 70 characters is enforced. | SKU123 |
| line_item_upc | String - UPC format enforced | The Universal Product Code (UPC). Must be 6 (UPC-E) or 12 (UPC-A) digits. | 876123432912 |
| line_item_ean | String - EAN format enforced | The European Article Number (EAN). Must be 8 or 13 digits. | 8932143245674 |
| line_item_gtin | String - GTIN format enforced | The Global Trade Item Number (GTIN). Must be 8, 12, 13, or 14 digits. | 00012345678905 |
| line_item_title | String | The title of the item. | Line Item Title |
| line_item_partner_sku | String | Partner SKU of the line item. | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_2 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_id_3 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_quantity |
Integer |
The quantity that has shipped in this package. |
1 |
| line_item_unit_of_measure |
string |
The unit of measure for the given line item. | CM |
| line_item_original_order_quantity | Integer | Original quantity ordered of the given line item. | 3 |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | ABC Products |
| line_item_serial_numbers | String | The serial number of the item that is being fulfilled. This may be required by law for items such as firearms. | abc123 |
| line_item_current_lifecycle | String | Indicates the lifecycle status for each quantity of the line_item. Format=Status::Quantity with multiple lifecycles separated by ^^ |
acknowledged::1^^cancelled::1 |
| supplier_order_number | String | Provided by suppliers. The unique identifier of the order within the supplier's order management system. | 123ABC |
| consumer_order_number | String | Normally supplied by the retailer - number used by the retailer to reference the order. | 123456789 |
| vendor_invoice_number | String | Invoice number used by the vendor. | 987654321 |
| balance_due | Float | Total amount due, after all charges, discounts, and previous payments are applied. | 23.50 |
| currency_code | String | The 3-letter ISO 4217 currency code. | USD |
| ship_to_attention | String | Ship-to attention line. | Barbara Jones |
| ship_to_name | String | Full name of the customer to whom the order is being shipped. Either this field or the ship_to_first_name and shipJ_to_last_name fields must be provided. | John Doe |
| ship_to_first_name | String | Customer's first name. | John |
| ship_to_last_name | String | Customer's last name. | Doe |
| ship_to_company | String | Customer's company name. | Cool Company, Inc. |
| ship_to_address_1 | String | Customer's first address line. | 433 N 3213 S |
| ship_to_address_2 | String | Customer's second address line. | Suite 700 |
| ship_to_address_3 | String | Customer's third address line. | Flat number 7 |
| ship_to_address_type | Enum | Is the address a residential or commercial address? Only two options available: 'Residential' or 'Commercial' | Residential |
| ship_to_city | String | Customer's city. | Mobile |
| ship_to_region | String | Customer's region (state in the US). | AL |
| ship_to_postal | String | Customer's postal code (ZIP code in the US). | 32421 |
| ship_to_country | String | Shipping country of the customer to whom the order is being shipped using the two-character ISO country code. If no country is provided, the default is 'US'. | US |
| ship_to_phone | String | Phone number of the customer to whom the order is being shipped. | 8018018014 |
| ship_to_email | String | Email address of the customer to whom the order is being shipped. | email@sample.com |
| ship_to_store_number | String | Ship-To Store Number. | B12 |
| ship_from_attention | String | Ship-from attention. | Johnny Walker |
| ship_from_name | String | Full name of the name of which the package is being shipped from. Either this field or the ship_from_first_name and ship_from_last_name fields must be provided. | John Doe |
| ship_from_first_name | String | Ship-from first name. | John |
| ship_from_last_name | String | Ship-from last name. | Doe |
| ship_from_company | String | Ship-from company name. | Cool Company, Inc. |
| ship_from_address_1 | String | Ship-from first address line. | 433 N 3213 S |
| ship_from_address_2 | String | Ship-from second address line. | Suite 700 |
| ship_from_address_3 | String | Address line 3 of the address from which the package is being shipped from. | Flat number 7 |
| ship_from_address_4 | String | Address line 4 of the address from which the package is being shipped from. | Flat number 7 |
| ship_from_address_5 | String | Address line 5 of the address from which the package is being shipped from. | Flat number 7 |
| ship_from_address_type | Enum | Is the address a residential or c ommercial address? Only two options available: 'Residential' or 'Commercial' | Residential |
| ship_from_city | String | Ship-from city. | Mobile |
| ship_from_region | String | Ship-from region (state in the US). | AL |
| ship_from_postal | String | Ship-from postal code (ZIP code in the US). | 32421 |
| ship_from_country | String | Ship-from country code. | US |
| ship_from_phone | String | Phone number provided by the supplier shipping the order. | 8018018014 |
| ship_from_email | String | Email provided by the supplier shipping the order. | email@sample.com |
| ship_from_location_code | String | Location code from which the order was shipped. | ABC123 |
| dsco_ship_carrier | String | The shipping carrier, as calculated by the platform. | FedEx |
| dsco_ship_method | String | The shipping method, as calculated by the platform. | Ground |
| dsco_shipping_service_level_code | String | The shipping service level, as calculated by the platform. | UPCG |
| retailer_ship_carrier | String | The shipping carrier requested by the retailer. | UPS |
| retailer_ship_method | String | The shipping method level requested by the retailer. | Ground |
| retailer_shipping_service_level_code | String | The shipping service level requested by the retailer. | FE2D |
| retailer_expected_delivery_date | Date-Time | Date the retailer expects the package to be delivered. | 2019-02-24T19:43:56+07:00 |
| retailer_required_delivery_date | Date-Time | Date by which the package must be delivered. | 2019-12-24T19:43:56+07:00 |
| transaction_id | String | Transaction or shipment ID. | 1234567 |
| transaction_date | Date-Time | Date this shipping transaction is sent. | 2019-12-24T19:43:56+07:00 |
| dsco_actual_ship_carrier | String | Carrier the platform recorded as the actual carrier used when shipping the order. | USPS |
| dsco_actual_ship_method | String | Shipping method the platform recorded as the actual method used when shipping the order. | Overnight |
| dsco_actual_shipping_service_level_code | String | Shipping service level code the platform recorded as the actual service level used when shipping the order. | FE2D |
| dsco_actual_ship_cost | Currency | Cost the platform recorded as the actual cost of shipping the order. | 12.54 |
| dsco_actual_delivery_date | Date-Time | Date the platform recorded as the actual delivery date of the package. | 2019-02-24T19:43:56+07:00 |
| dsco_actual_pickup_date | Date-Time | Date the platform recorded as the actual pickup date of the package. | 2019-02-24T19:43:56+07:00 |
| dsco_package_id | Integer | The Package ID assigned by the platform for the given tracking or package within the platform. | 123456789 |
| dsco_order_id | Integer | The Order ID assigned by the platform for the given Order within the platform. | 2315758 |
| dsco_order_status | String | The status of the order assigned by the platform. | Created |
| dsco_lifecycle | Enum | Indicates the lifecycle status of the order. Details provided here. Enum: 'received', 'created', 'acknowledged', 'completed' | created |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the platform. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the platform. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_trading_partner_parent_id | String | The Parent ID of the partner that the account has set within their Trading Partner settings for this particular partner. | 456 |
| dsco_trading_partner_name | String | The Name that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | Name |
| dsco_requested_ship_carrier | String | The original ship_carrier requested when the order was created. Used by the retailer to compare how the supplier shipped the package compared to how the retailer requested it to be shipped. | UPS |
| dsco_requested_ship_method | String | The original ship_method requested when the order was created. Used by the retailer to compare how the supplier shipped the package compared to how the retailer requested it to be shipped. | Ground |
| dsco_requested_shipping_service_level_code | String | The original shipping_service_level_code requested when the order was created. Used by the retailer to compare how the supplier shipped the package compared to how the retailer requested it to be shipped. | G1 |
| dsco_create_date | Date-Time | The date that the SKU was originally created within the platform. | 2019-02-24T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the SKU was last updated by the supplier. This could include title or anything else that is supported. | 2019-02-24T19:43:56+07:00 |
| untracked | Bool |
When using a carrier service that does not provide a tracking number, this field is use to note that distinction.
Supplier will instead provide a value in the package tracking number field vs a carrier supplier value. |
1 |
| ship_from_tax_exempt_number | String |
The Ship From Tax Exempt Number |
123456789 |
| ship_from_tax_registration_number | String |
The Ship from Tax Registration Number |
123456789 |
| ship_to_tax_exempt_number | String |
The Ship To Tax Exempt Number |
123456789 |
| ship_to_tax_exempt_number | String |
The Ship To Tax Registration Number |
123456789 |
Import File Naming Convention
When setting up a standard job, the name should match the following rules although you always have the option of specifying a different filename if needed:
- Start (prefix) with "Order_Shipment_".
- Next, it is suggested that retailers provide a time stamp to ensure that order files are not overwritten by newer files before the system has a chance to import the existing files.
- End in ".tab" for Tab delimited files, ".csv" for Comma delimited files, ".tsv" for Pipe delimited files, and ".xls" for Excel files.
Example: Order_Shipment_20150229145656.tab
Export File Naming Convention
Order Shipment files that are exported from the platform will follow these file naming rules:
- Start (prefix) with "Order_Shipment_".
- Next, include the date and time in format "YYYYMMDDHHMMSS".
- End in ".xls" for Excel files, ".tab" for Tab delimited files, ".csv" for Comma delimited files, and ".tsv" for Pipe delimited files.
Example: Order_Shipment_20150229134553.tab
Returned Shipment Schema
The returned shipment file is an extension of the shipment file. All fields included in the shipment file are also available in the returned shipment file. The nine fields below can simply be included in the shipment file when submitting information for a returned shipment.
| Field Name | Data Type | Field Description | Example |
| return_number | String | The unique return identifier for the given return. | abc1234 |
| dsco_order_id | String | Unique ID created within the DSCO platform | abc1234 |
| po_number | String | The unique order identifier as provided by the retailer's ordering system. The po_number must exist within the supplier's Dsco account. This is a required field. | abc1234 |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. | 12345c |
| return_date | Date-Time | The date for the return, set by the creating partner on creation. | 2019-02-28T19:43:56+07:00 |
| return_reason | String | The reason the return was created. | Undeliverable |
| requested_action | String | Instructions regarding replacement, repair and/or handling of customer account. | Damaged goods, please dispose |
| return_tracking_numbers | String | The tracking number(s) used by the sending party to return the items to the receiving party. Format : {carrier}::{tracking_number}^^{carrier}::{tracking_number} |
ups::r_123456^^fedex::r_78910 |
| dsco_trading_partner_id | String | The identifier that the Dsco platform may be able to identify the account the order should be Auto-population Sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| tracking_numbers_1 | String | The single tracking number used by the sending party to return the items to the receiving party. One return required per shipment | t_123456 |
| tracking_numbers_2 | String | The single tracking number used by the sending party to return the items to the receiving party. One return required per shipment | t_789123 |
| transaction_date | Date-Time | Date-Time of the return transaction. | 2023-05-01T00:00:00+00:00 |
| transaction_id | String | Assigned Id of the return transaction. | A123456 |
| dsco_line_item_item_id | Integer | The id assigned by Dsco for the given SKU within Dsco. | 24152 |
| line_item_ean | String - EAN Format Enforced | EAN of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 8453287651234 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Field Limitations - GTIN = 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_isbn | String | ISBN of the line-items. Enforced 13-character formatting. | 9780399592522 |
| line_item_mpn | String | MPN of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | MPN-123-456 |
| line_item_partner_sku | String | Partner SKU of the item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 123_ps |
| line_item_sku | String | The SKU being referenced for this line_item record. This must match a SKU included in the original order within Dsco. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | SKU123 |
| line_item_upc | String - UPC Format Enforced | UPC of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 932123083564 |
| line_item_line_number | Integer | Line item number of the SKU on the order. This should match the line_item_line_number on the order and shipment. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
1 |
| line_item_quantity | Integer | Quantity of the line-item units being returned. | 1 |
| line_item_reason_code | String - Predefined Dsco codes are documented but users may set up a mapping to use their own codes. | The following codes will be accepted unless a code mapping has been configured within the Dsco account's mapping settings: CRP = Defective Product CRR = Customer Regret CRD = Damaged CRN = Product not as described CRU = Undeliverable |
CRR |
| line_item_adjustments | String | Tthe adjustments listed for the file. The format for this will be {adjustment reason}::{adjustment}^^{adjustment_reason_2::{adjustment} | undeliverable::1^^damaged::0.50 |
| line_item_title_i18n_en_us | String | Title translation value for a given line on the return. The value in {locale} is the locale code (i.e en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_america |
| line_item_title_i18n_en_ca | String | Title translation value for a given line on the return. The value in {locale} is the locale code (i.e en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_other_locale |
| line_item_color | String | The color of the line item. | Blue |
| line_item_name | Integer | The name of SKU | 1 |
| line_item_personalization | String | Instructions for personalization. | Name “Frederick” to be embroidered on the left sleeve. |
| line_item_size | String | The size of the line item. | Large |
| line_item_title | String | The title of the SKU being ordered. If the option to create unknown SKUs is enabled, this title will be used as the new SKU's title. | SKU Title |
| line_item_retailer_item_ids_1 | String | The retailer-provided Retailer Item IDs for the item being returned. | lfg123 |
| line_item_retailer_item_ids_2 | String | The retailer-provided Retailer Item IDs for the item being returned. | lfg123 |
| Field Name | Date Type | Field Description | Example |
| return_number | String | Return number | asdf4321 |
| return_date | Date-Time | Date the item was returned. | 2019-02-29T19:43:56+07:00 |
| package_sscc_barcode | String | Serial Shipping Container Code (SSCC) barcode of the package. | 00123356789067845678 |
| return_reason | String | Provided reason for why the item was returned. | Customer rejected shipment. |
| number_of_line_items | Integer | Number of line items on the order. Reject update if the number of line items doesn't match the actual number of line items included. | 3 |
| line_item_line_number | Integer | Line item number of the SKU on the order. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
2 |
| line_item_upc | String - UPC format enforced | The Universal Product Code (UPC) provided for the SKU. | 834319321203 |
| line_item_ean | String - EAN format enforced | The European Article Number provided for the SKU. | 7439212832422 |
| line_item_partner_sku | String | Partner SKU defined for the line item. | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per order. Each new ID should be incremented by 1, i.e. item_id_1, item_id_2, and item_id_3. |
lfg123 |
| line_item_original_order_quantity | Integer | The original quantity included on the order. | 3 |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | ABC Products |
Invoice Schema
| Field Name |
Data Type |
Field Description |
Example |
| invoice_id | String | The unique invoice identifier as generated by the supplier's financial system. The invoice_id must be unique within the supplier's account in the platform, meaning that an Invoice ID cannot be used more than once. | 123456 |
| po_number | String | The unique order identifier as provided by the retailer's ordering system. The po_number must exist within the supplier's account in the platform. | abc1234 |
| invoice_total_amount | Currency | The grand total of the invoice. This is the amount that the supplier expects the retailer to pay for this specific invoice unless a terms are provided which specifies that a discount is available if paid by a certain date. The invoice_total_amount is the sum of invoice_line_items_subtotal and invoice_subtotal_excluding_line_items if those fields are provided. | 44.50 |
| invoice_date | Date-Time | The date that the invoice was created or invoiced from within the supplier's financial system. If an invoice_date is not provided, the platform will use the current date as the invoice date. | 2019-02-24T19:43:56+07:00 |
| invoice_currency_code | String | The 3-letter ISO 4217 currency code. | USD |
| invoice_subtotal_excluding_line_items | Currency - No $ sign | The sum of invoice_handling_amount, invoice_freight_amount and invoice_sales_tax_amount. | 40.00 |
| invoice_line_items_subtotal | Currency - No $ sign | The sum of all line_item_subtotal values. | 40.00 |
| invoice_handling_amount | Currency - No $ sign | The amount being charged for handling charges at the invoice level. | 40.00 |
| invoice_freight_amount | Currency - No $ sign | The total amount being charged for freight if charged at the invoice level. If freight is charged at the line_item level you can provide a value for each within the line_item_ship_amount field and set this to 0. | 10.00 |
| invoice_sales_tax_amount | Currency - No $ sign | The amount being charged for sales tax at the invoice level. line_item level tax charges can be set within the line_item_tax_amount field. | 1.00 |
| invoice_number_of_line_items | Integer | The total number of line-items included on the invoice update. | 2 |
| line_item_line_number | Integer | Line item number of the SKU on the order. This should match the line_item_line_number on the order and shipment. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
1 |
| line_item_sku | String | The SKU being referenced for this line_item record. This must match a SKU included in the original order within the platform. This is not a required field, but it is suggested that you include it. A limit of 70 characters is enforced. | SKU123 |
| line_item_upc | String - UPC format enforced | The Universal Product Code (UPC). Must be 6 (UPC-E) or 12 (UPC-A) digits. | 932123083564 |
| line_item_ean | String - EAN format enforced | The European Article Number (EAN). Must be 8 or 13 digits. | 8453287651234 |
| line_item_gtin | String - GTIN format enforced | The Global Trade Item Number (GTIN). Must be 8, 12, 13, or 14 digits. | 00012345678905 |
| line_item_mpn | String | Manufacturer Part Number | MPN-123-456 |
| line_item_partner_sku | String | Partner SKU of the item being invoiced. | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per item. Each new ID should be incremented by 1, i.e. item_id_1, item_id_2, and item_id_3. |
lfg123 |
| line_item_retailer_item_id_2 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per item. Each new ID should be incremented by 1, i.e. item_id_1, item_id_2, and item_id_3. |
lfg123 |
| line_item_retailer_item_id_3 | String | Secondary part number included by the retailer. *The platform can support up to three line_item_retailer_item_id_x fields per item. Each new ID should be incremented by 1, i.e. item_id_1, item_id_2, and item_id_3. |
lfg123 |
| line_item_title | String | The title of the line_item_sku. | Title of SKU123 |
| line_item_department_id | String | ID of the retailer department that initiated the order. | 24 |
| line_item_department_name | String | Name of the retailer department that initiated the order. | Paint-Exterior |
| line_item_merchandising_account_id | String | ID of the retailer merchandising account. | 33 |
| line_item_merchandising_account_name | String | Name of the retailer merchandising account. | ABC Products |
| line_item_warehouse_code | String | The supplier's code for the warehouse from which this line-item shipped. | Warehouse1 |
| line_item_warehouse_retailer_code | String | The retailer's code for the warehouse from which this line-item shipped. | Warehouse1 |
| line_item_warehouse_dsco_id | String | The platform's internal code for the warehouse from which this line-item shipped. | w5a735f8fb5484253102350 |
| line_item_requested_warehouse_dsco_id | String | The platform's internal code for the warehouse requested by the retailer. | w5a735f8fb5484253102350 |
| line_item_requested_warehouse_code | String | The supplier code for the warehouse requested by the retailer. | Warehouse1 |
| line_item_requested_warehouse_retailer_code | String | The retailer code for the warehouse requested by the retailer. | Warehouse1 |
| line_item_unit_price | Currency - No $ sign | The price or cost for each line_item_sku. Do not multiply the quantity being charged. Used in conjunction with line_item_unit_of_measure. | 23.32 |
| line_item_basis_of_unit_price | String | The bases of the unit price. Possible values are: 'QT' - Quoted 'LE' - Catalog Price per Each 'NC' - No Charge 'LD' - Catalog Price per Dozen 'WE' - Wholesale Price per Each 'WD' - Wholesale Price per Dozen |
QT |
| line_item_quantity | Integer | The quantity of line_item_sku that is being invoiced. This is not a required field, but it is suggested that you include it. | 1 |
| line_item_original_order_quantity | Integer | The original quantity of items on the order. | 3 |
| line_item_unit_of_measure | String | The unit of measure for line_item_unit_price. Possible values are: 'EA' - Each | EA |
| line_item_extended_amount | Currency - No $ sign | The amount of line_item_unit_price multiplied by line_item_quantity. | 12.50 |
| line_item_handling_amount | Currency - No $ sign | The total amount being charged for handling charges for this specific line_item_sku. | 12.50 |
| line_item_msrp | Currency - No $ sign | The MSRP or current selling price of the given line-item. | 5.23 |
| line_item_commission_percentage | Float | The percentage the supplier has set for the given trading partner to calculate the commission amount for an item when sold. | 8.5 |
| line_item_ship_date | Date-Time | The date that the line_item_sku was shipped. | 2019-02-24T19:43:56+07:00 |
| line_item_tracking_number | String | The tracking number of the package that included this specific line_item_sku. | 1Z123456789 |
| line_item_ship_amount | Currency - No $ sign | The total amount being charged for shipping for this specific line_item_sku. | 12.50 |
| line_item_ship_carrier | String | The carrier that shipped the package that included this specific line_item_sku. | FedEx |
| line_item_ship_method | String | The shipping method used by the carrier to ship the package that included this specific line_item_sku. | Ground |
| line_item_shipping_service_level_code | String | Used in conjunction with line_item_ship_carrier and line_item_ship_method, this allows the supplier to provide a pre-defined shipping code that the retailer can recognize. | G1 |
| line_item_dsco_package_id | Integer | Package ID generated by the platform to uniquely identify the shipment. | 1 |
| line_item_sscc_barcode | String | Serial Shipping Container Code (SSCC) barcode of the package. | 00123356789067845678 |
| line_item_ship_weight | Integer | Weight of the item shipped in the package. | 12 |
| line_item_ship_weight_units | Enum | Unit of measurement for the weight of the item. Enum: 'lb', 'oz', 'g', 'kg' | Kg |
| line_item_ship_reference_number_qualifier | Enum | The reference number qualifier for this shipment. Possible values include: 'BM' for Bill of Lading Number, 'CN' for Carrier's Reference Number. | BM |
| line_item_ship_transportation_method_code | Enum | The transportation method code assigned by the carrier for the shipped package. Possible values include: 'A' for Air, 'J' for Motor, 'R' for Rail, 'S' for Ocean/Ship. | A |
| line_item_ship_unit_of_measurement_code | Enum | The unit of measurement code. Typically "EA" for "Each". "PR" for "Pair" is also acceptable. | EA |
| line_item_ship_carrier_manifest_id | String | The Carrier Manifest ID as generated by the LTL carrier. | abc123 |
| line_item_serial_numbers | String | The serial number of the item that is being fulfilled. This may be required by law for items such as firearms. | abc123 |
| line_item_tax_amount_1 | Currency - No $ sign | Tax amount calculated on the line item. | 1.23 |
| line_item_tax_percentage_1 | Float | Percent amount of defined taxes. | 20.0 |
| line_item_tax_type_code_1 | String - <=10 | Line Item Tax Type Code | CG |
| line_item_tax_jurisdiction_qualifier_1 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. | State or Province |
| line_item_tax_jurisdiction_1 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| line_item_tax_exempt_code_1 | Enum |
One of the following: 'No (Not Tax Exempt)', |
Not Exempt (Not For Resale) |
| line_item_tax_registration_number_1 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| line_item_tax_description_1 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| line_item_tax_amount_2 | Currency - No $ sign | Tax amount calculated on the line item. | 1.23 |
| line_item_tax_percentage_2 | Float | Percent amount of defined taxes. | 20.0 |
| line_item_tax_type_code_2 | String - <=10 | Line Item Tax Type Code | CG |
| line_item_tax_jurisdiction_qualifier_2 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. | State or Province |
| line_item_tax_jurisdiction_2 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| line_item_tax_exempt_code_2 | Enum | One of the following: 'No (Not Tax Exempt)', 'Exempt (For Resale)', 'Not Exempt/For Resale', 'Exempt (Not For Resale)', 'Not Exempt, Not For Resale', 'Direct Pay ID', 'Exempt (Sale to U.S. Government)', 'Exempt (Per State Law)', 'Labor Taxable, Material Exempt', 'Material Taxable, Labor Exempt', 'Not Taxable', 'Disabled', 'Exempt Toll Service', 'Exempt (Goods and Services Tax)', 'Exempt (Provincial Sales Tax)', 'Homestead', 'Agriculture', 'Working Farm', 'Open Space', 'Exempt Local Service', 'Disabled Veteran', 'Non-Homestead', 'Over 65', 'Exempt from School Property Tax', 'Exempt from Local Property Tax', 'Recurring Exempt', 'Exempt from County Property Tax', 'Totally Exempt', 'Usage Exempt', 'Exempt from State Property Tax', 'Other Property Tax Exemption', 'Exempt - Letter on file' |
Not Exempt (Not For Resale) |
| line_item_tax_registration_number_2 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| line_item_tax_description_2 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| line_item_tax_amount_3 | Currency - No $ sign | Tax amount calculated on the line item. | 1.23 |
| line_item_tax_percentage_3 | Float | Percent amount of defined taxes. | 20.0 |
| line_item_tax_type_code_3 | String - <=10 | Line Item Tax Type Code | CG |
| line_item_tax_jurisdiction_qualifier_3 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. | State or Province |
| line_item_tax_jurisdiction_3 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| line_item_tax_exempt_code_3 | Enum |
One of the following: 'No (Not Tax Exempt)', |
Not Exempt (Not For Resale) |
| line_item_tax_registration_number_3 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| line_item_tax_description_3 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| line_item_taxable_amount_of_sale | Currency - No $ sign | Indicates the sale amount that was taxable at the line-level. | 45.21 |
| line_item_amount_of_sales_tax_collected | Currency - No $ sign | The amount of sales tax collected for the given line-item. | 45.21 |
| line_item_promotion_reference | String | If the line_item_unit_price is discounted because of a promotion that the supplier is running, this field can be used to reference the promotion's title or description. | End-of-year Special |
| line_item_promotion_amount | Currency - No $ sign | The amount being discounted for each line_item_sku for the given line_item_promotion_reference. | 12.50 |
| line_item_carb_certifier_id | String | The ID of the certifier who certified that the item passes the California Air Resource Board (CARB) requirements. | 123456 |
| line_item_carb_formaldehyde_compliance_code | String | The California Air Resource Board (CARB) formaldehyde compliance code for the item. | ABC123 |
| line_item_tax_amount | Currency - No $ sign | The amount of tax being charged for this line_item_sku. | 12.50 |
| line_item_subtotal | Currency - No $ sign | The total of the following fields: line_item_extended_amount line_item_handling_amount line_item_ship_amount line_item_promotion_amount line_item_tax_amount |
12.50 |
| invoice_charge_title_1 | String | A short explanation of the first of any extra charges that cannot be specified within any other fields available within the Invoice specifications. This is an invoice level charge. | Charge 1 |
| invoice_charge_amount_1 | Currency - No $ sign | The amount being charged for invoice_charge_title_1. | 12.56 |
| invoice_charge_title_2 | String | A short explanation of the first of any extra charges that cannot be specified within any other fields available within the Invoice specifications. This is an invoice level charge. | Charge 2 |
| invoice_charge_amount_2 | Currency - No $ sign | The amount being charged for invoice_charge_title_1. | 12.50 |
| invoice_charge_title_3 | String | A short explanation of the first of any extra charges that cannot be specified within any other fields available within the Invoice specifications. This is an invoice level charge. | Charge 3 |
| invoice_charge_amount_3 | Currency - No $ sign | The amount being charged for invoice_charge_title_1. | 12.50 |
| invoice_total_amount_subject_to_terms_discount | Currency - No $ sign | The amount of the invoice total that is subject to discount. | 12.50 |
| invoice_terms_type | Enum | The type of terms applied to this invoice. Possible values include: '01' for 'Basic' '02' for 'EOM (End of Month)' '05' for 'Discount not applicable' '08' for 'Basic discount offered' '12' for '10 EOM (10 Days after end of month)' |
01 |
| invoice_terms_basis_date | Date-Time | The invoice date pertaining to the invoice terms. | 2019-02-24T19:43:56+07:00 |
| invoice_terms_discount_percent | Float | The percent of discount available if paid before the invoice_terms_discount_due_date. | 2.0 |
| invoice_terms_discount_due_date | Date-Time | The date the invoice must be paid to get any discounts. Conditionally Recommended if '08' is used within invoice_terms_type. | 2019-02-24T19:43:56+07:00 |
| invoice_terms_discount_days_due | Integer | The number of days from the invoice date the invoice must be paid by to qualify for any discounts. Conditionally Recommended if '08' is used within invoice_terms_type. | 5 |
| invoice_terms_net_due_date | Date-Time | The date the invoice must be paid in full. Conditionally Recommended. Conditionally Recommended if '01' is used within invoice_terms_type. | 2019-02-24T19:43:56+07:00 |
| invoice_terms_net_days | Integer | The number of days from the invoice date that the invoice must be paid in full. Conditionally Recommended. Conditionally Recommended if '01' is used within invoice_terms_ty |
15 |
| invoice_terms_discount_amount | Currency - No $ sign | The amount that is discounted from the invoice total amount if the invoice is paid on or before the invoice_terms_discount_due_date. | 7.34 |
| invoice_terms_day_of_month | Integer | The number of days after the end of the month that the invoice is due. Used in conjunction with codes 02 or 12 within invoice_terms_type. | 15 |
| tax_amount_1 | Currency - No $ sign | Tax amount calculated on the order. | 1.23 |
| tax_percentage_1 | Float | Percent amount of defined taxes | 2.75 |
| tax_type_code_1 | String <=10 | Tax Type Code | VAT_A |
| tax_jurisdiction_qualifier_1 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. | State or Province |
| tax_jurisdiction_1 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| tax_exempt_code_1 | Enum | One of the following: 'No (Not Tax Exempt)', 'Exempt (For Resale)', 'Not Exempt/For Resale', 'Exempt (Not For Resale)', 'Not Exempt, Not For Resale', 'Direct Pay ID', 'Exempt (Sale to U.S. Government)', 'Exempt (Per State Law)', 'Labor Taxable, Material Exempt', 'Material Taxable, Labor Exempt', 'Not Taxable', 'Disabled', 'Exempt Toll Service', 'Exempt (Goods and Services Tax)', 'Exempt (Provincial Sales Tax)', 'Homestead', 'Agriculture', 'Working Farm', 'Open Space', 'Exempt Local Service', 'Disabled Veteran', 'Non-Homestead', 'Over 65', 'Exempt from School Property Tax', 'Exempt from Local Property Tax', 'Recurring Exempt', 'Exempt from County Property Tax', 'Totally Exempt', 'Usage Exempt', 'Exempt from State Property Tax', 'Other Property Tax Exemption', 'Exempt - Letter on file' |
Not Exempt (Not For Resale) |
| tax_registration_number_1 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| tax_description_1 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| tax_amount_2 | Currency - No $ sign | Tax amount calculated on the order. | 1.23 |
| tax_percentage_2 | Float | Percent amount of defined taxes | 2.75 |
| tax_type_code_2 | String <=10 | Tax Type Code | VAT_A |
| tax_jurisdiction_qualifier_2 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. |
State or Province |
| tax_jurisdiction_2 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| tax_exempt_code_2 | Enum | One of the following: 'No (Not Tax Exempt)', 'Exempt (For Resale)', 'Not Exempt/For Resale', 'Exempt (Not For Resale)', 'Not Exempt, Not For Resale', 'Direct Pay ID', 'Exempt (Sale to U.S. Government)', 'Exempt (Per State Law)', 'Labor Taxable, Material Exempt', 'Material Taxable, Labor Exempt', 'Not Taxable', 'Disabled', 'Exempt Toll Service', 'Exempt (Goods and Services Tax)', 'Exempt (Provincial Sales Tax)', 'Homestead', 'Agriculture', 'Working Farm', 'Open Space', 'Exempt Local Service', 'Disabled Veteran', 'Non-Homestead', 'Over 65', 'Exempt from School Property Tax', 'Exempt from Local Property Tax', 'Recurring Exempt', 'Exempt from County Property Tax', 'Totally Exempt', 'Usage Exempt', 'Exempt from State Property Tax', 'Other Property Tax Exemption', 'Exempt - Letter on file' |
Not Exempt (Not For Resale) |
| tax_registration_number_2 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| tax_description_2 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| tax_amount_3 | Currency - No $ sign | Tax amount calculated on the order. | 1.23 |
| tax_percentage_3 | Float | Percent amount of defined taxes | 2.75 |
| tax_type_code_3 | String <=10 | Tax Type Code | VAT_A |
| tax_jurisdiction_qualifier_3 | Enum | One of the following: 'Customer defined', 'Taxing Authority Code', 'State or Province', 'State Defined', 'Vendor defined', 'Vertex'. |
State or Province |
| tax_jurisdiction_3 | String | Region or jurisdiction applied when calculating taxes for the order. | QST |
| tax_exempt_code_3 | Enum | One of the following: 'No (Not Tax Exempt)', 'Exempt (For Resale)', 'Not Exempt/For Resale', 'Exempt (Not For Resale)', 'Not Exempt, Not For Resale', 'Direct Pay ID', 'Exempt (Sale to U.S. Government)', 'Exempt (Per State Law)', 'Labor Taxable, Material Exempt', 'Material Taxable, Labor Exempt', 'Not Taxable', 'Disabled', 'Exempt Toll Service', 'Exempt (Goods and Services Tax)', 'Exempt (Provincial Sales Tax)', 'Homestead', 'Agriculture', 'Working Farm', 'Open Space', 'Exempt Local Service', 'Disabled Veteran', 'Non-Homestead', 'Over 65', 'Exempt from School Property Tax', 'Exempt from Local Property Tax', 'Recurring Exempt', 'Exempt from County Property Tax', 'Totally Exempt', 'Usage Exempt', 'Exempt from State Property Tax', 'Other Property Tax Exemption', 'Exempt - Letter on file' |
Not Exempt (Not For Resale) |
| tax_registration_number_3 | String | Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. | 123456 |
| tax_description_3 | String | Description of the tax applied to the line item. | Canada VAT-QST |
| remit_to_attention | String | Person/Title/Department Name of whoever is responsible for the receiving the invoice payment. |
Bill Able |
| remit_to_name | String | Person/Title/Department Name of whoever is responsible for the receiving the invoice payment. | John Doe |
| remit_to_first_name | String | First name of remit to **Deprecated use of remit_to_name** | John |
| remit_to_last_name | String | Last name of remit to **Deprecated use of remit_to_name** | Doe |
| remit_to_company | String | The name of the company that is responsible for receiving the invoice payment. | Company Name LLC |
| remit_to_address_1 | String | The first address line of the company who is responsible for receiving the invoice payment. | 123 North 456 West |
| remit_to_address_2 | String | The second address line of the company who is responsible for receiving the invoice payment. | Apt. 2b |
| remit_to_address_3 | String | The third address line of the company who is responsible for receiving the invoice payment. | Flat number 7 |
| remit_to_address_type | Enum | Is the address a residential or commercial address? Only two options available: 'Residential' or 'Commercial'. | Residential |
| remit_to_city | String | The city of the company who is responsible for receiving the invoice payment. | Mobile |
| remit_to_region | String | The region of the company who is responsible for receiving the invoice payment. In the United States, this is the state. | GA |
| remit_to_postal | String | The postal code of the company who is responsible for receiving the invoice payment. | 31907 |
| remit_to_country | String | The country code of the company who is responsible for receiving the invoice payment using the two-character ISO country code. | US |
| remit_to_phone | String | The phone number of the company who is responsible for receiving the invoice payment. | 8075551232 |
| remit_to_email | String | The email address of the company who is responsible for receiving the invoice payment. | email@sample.com |
| remit_to_location_code | String | The location code of the company who is responsible for receiving the invoice payment. | ABC123 |
| seller_attention | String | Person/Title/Department Name of the Seller. | Bill Able |
| seller_name | String | The name of the seller. | John Doe |
| seller_first_name | String | First name of seller **Deprecated use of seller_name** | John |
| seller_last_name | String | Last name of seller **Deprecated use of seller_name** | Doe |
| seller_company | String | The company name of the seller. | Company Name LLC |
| seller_address_1 | String | The first address line of the seller. | 124 North 456 West |
| seller_address_2 | String | The second address line of the seller. | Apt. 2b |
| seller_address_3 | String | The third address line of the seller. | Flat number 7 |
| seller_city | String | The city of the seller. | Mobile |
| seller_region | String | The region of the seller. In the United States, this is the state. | AL |
| seller_postal | String | The postal code of the seller. | 76244 |
| seller_country | String | The country code of the seller using the two-character ISO country code. | US |
| seller_phone | String | The phone number of the seller. | 8075551238 |
| seller_email | String | The email address of the seller. | email1@email.com |
| seller_tax_registration_number | String | The tax registration number of the seller. | ABC123 |
| buyer_attention | String | Person/Title/Department Name of the buyer. | Bill Able |
| buyer_name | String | The name of the buyer. | John Doe |
| buyer_first_name | String | First name of buyer **Deprecated use of buyer_first_name** | John |
| buyer_last_name | String | Last name of buyer **Deprecated use of buyer_first_name** | Doe |
| buyer_company | String | The company name of the buyer. | Company Name LLC |
| buyer_address_1 | String | The first address line of the buyer. | 125 North 456 West |
| buyer_address_2 | String | The second address line of the buyer. | Apt. 2b |
| buyer_address_3 | String | The third address line of the buyer. | Flat number 7 |
| buyer_city | String | The city of the buyer. | Paris |
| buyer_region | String | The region of the buyer. In the United States, this is the state. | TX |
| buyer_postal | String | The postal code of the buyer. | 75065 |
| buyer_country | String | The country code of the buyer using the two-character ISO country code. | US |
| buyer_phone | String | The phone number of the buyer. | 8075551235 |
| buyer_email | String | The email of the buyer. | email@email.com |
| buyer_tax_registration_number | String | The tax registration number of the buyer. | ABD123 |
| remit_to_tax_exempt_number | String | The tax exempt number of the company who is responsible for receiving the invoice payment. | ABC123 |
| ship_to_attention | String | Name of the person included on the ATTN line of the order. | Bill Able |
| ship_to_name | String | Full name of the customer to whom the order is being shipped. Either this field or the ship_to_first_name and shipJ_to_last_name fields must be provided. | John Doe |
| ship_to_first_name | String | The first name to whom the package was shipped. | Frederick |
| ship_to_last_name | String | The last name to whom the package was shipped. | Von Giezer |
| ship_to_company | String | The company name to whom the package was shipped. | Company Name LLC |
| ship_to_address_1 | String | The main address to where the package was shipped. | 123 North 456 West |
| ship_to_address_2 | String | The secondary address to where the package was shipped. | Apt. 2b |
| ship_to_address_3 | String | Address 3 line of the customer to whom the order is being shipped. | Flat number 7 |
| ship_to_address_type | Enum | Is the address a residential or commercial address? Only two options available: 'Residential' or 'Commercial'. | Residential |
| ship_to_city | String | The city to where the package was shipped. | Fakeville |
| ship_to_region | String | The region to where the package was shipped. In the United States, this is the state. | GA |
| ship_to_postal | String | The postal code to where the package was shipped. | 31907 |
| ship_to_country | String | The country code to where the package was shipped using the two-character ISO country code. If no country is provided, the default is 'US'. | US |
| ship_to_phone | String | Phone number of the person or store receiving the item. | 8014536721 |
| ship_to_email | String | Email of the person or store receiving the item. | invoices@sample.com |
| ship_to_store_number | String | Store number to which the order was shipped. | B12 |
| ship_number_of_units_shipped | Integer | The number of units shipped within the package. | 1 |
| ship_unit_of_measurement_code | String | The unit of measurement code. Typically "EA" for "Each". "PR" for "Pair" is also acceptable. | EA |
| ship_weight | Float | The weight of the package. | 1.2 |
| ship_weight_units | Enum | The unit of weight used with the 'ship_weight' field. Possible values include: 'lb', 'oz', 'g', 'kg' | lb |
| ship_date | Date-Time | The date that the package shipped. | 2019-02-24T19:43:56+07:00 |
| ship_tracking_number | String | The tracking number of the package as assigned by the carrier. | 1Z123456789 |
| dsco_package_id | Integer | The Package ID assigned by the platform for the given tracking or package within the platform. | 123456789 |
| ship_sscc_barcode | String | Serial Shipping Container Code (SSCC) barcode of the package. | 00123356789067845678 |
| ship_carrier | String | The carrier that is shipping the package. | UPS |
| ship_method | String | The shipment method that the package was shipped. | Ground |
| shipping_service_level_code | String | Used in conjunction with ship_carrier and ship_method, this allows the retailer to pass their own code, or the code that the supplier is expecting, using a pre-defined code that is agreed to between the supplier and retailer. | G1 |
| ship_transportation_method_code | String | The transportation method code assigned by the carrier for the shipped package. Possible values include: 'A' for Air, 'J' for Motor, 'R' for Rail, 'S' for Ocean/Ship | A |
| ship_reference_number_qualifier | String | The reference number qualifier for this shipment. Possible values include: 'BM' for Bill of Lading Number, 'CN' for Carrier's Reference Number | CN |
| ship_carrier_manifest_id | String | The Carrier Manifest ID as generated by the LTL carrier. | abc123 |
| ship_warehouse_code | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. | Warehouse1 |
| ship_warehouse_retailer_code | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. | Warehouse1 |
| ship_warehouse_dsco_id | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. | w5a735f8fb5484253102350 |
| requested_warehouse_code | String | This is a value specified by a supplier to map to a specific warehouse. | Warehouse1 |
| requested_warehouse_retailer_code | String | This is a value specified by a retailer on warehouses that already exist in the platform for suppliers to which they have access. | Warehouse1 |
| requested_warehouse_dsco_id | String | This is an ID generated by the platform when a warehouse is created within the system. | w5a735f8fb5484253102350 |
| dsco_warehouse_code | String | This is a recommendation based on Shipping Science. | Warehouse1 |
| dsco_warehouse_retailer_code | String | This is a recommendation based on Shipping Science. | Warehouse1 |
| dsco_warehouse_dsco_id | String | This is a recommendation based on Shipping Science. | w5a735f8fb5484253102350 |
| invoice_buyer_id | String | The identifier assigned by the seller's financial systems for the buyer/retailer from whom the order originated. | 12345 |
| invoice_seller_id | String | The identifier assigned by the buyer/retail's financial systems for the seller/supplier to whom the order was sent to. | 12345 |
| origin_id | String | The ID that was assigned by the original system that created the transaction. | ABC123 |
| invoice_seller_invoice_number | String | The seller/supplier's Packing Slip Number, Picking Ticket Number, or Control Number. | 12345 |
| supplier_order_number | String | Provided by suppliers. The unique identifier of the order within the supplier's order management system. | 12345 |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. | 12345 |
| external_batch_id | String | The identifier of the batch that included this update. Usually the group number of an EDI transaction. | 12345 |
| order_type | Enum | Used to indicate whether an order is 'drop ship/stand alone' or a 're-order' or a wholesale order. Options include: 'Dropship', 'Wholesale' | Dropship |
| amount_of_sales_tax_collected | Currency - No $ sign | Sum of the line-item amount of sales tax collected. | 1.23 |
| taxable_amount_of_sale | Currency - No $ sign | Indicates the sale amount that was taxable. Sum of line-items. | 1.23 |
| credits_title_1 | String | The title/short description of the credit. | Credit Title 1 |
| credits_amount_1 | Currency - No $ sign | Amount of the credit. | 1.23 |
| credits_title_2 | String | The title/short description of the credit. | Credit Title 2 |
| credits_amount_2 | Currency - No $ sign | Amount of the credit. | 1.23 |
| credits_title_3 | String | The title/short description of the credit. | Credit Title 3 |
| credits_amount_3 | Currency - No $ sign | Amount of the credit. | 1.23 |
| flsa_compliance_flag | Bool - | Indicates whether the item is FLSA compliant. '1' for TRUE, '0' for FALSE | 1 |
| dsco_invoice_id | Integer | The Invoice ID assigned by the platform for the given Invoice within the platform. | i1617d18cb03d5311612115 |
| dsco_order_id | Integer | The Order ID assigned by the platform for the given Order within the platform. | 2315758 |
| dsco_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. | 2315758 |
| dsco_invoice_status | Integer | The status of the invoice assigned by the platform. | 2315758 |
| dsco_expected_line_item_amount | Currency | The subtotal amount for the line-item data as calculated by the platform. | 14.23 |
| dsco_expected_line_item_difference | Currency | The difference between the dsco_expected_line_item_amount and the line_item_subtotal. | 0.23 |
| dsco_expected_order_total_difference | Currency | The difference between dsco_expected_order_total_amount and invoice_total_amount. This doesn't necessarily indicate a problem, only that we detected that there may be a difference between what the platform thought the order total should be and what the supplier indicated the total was for this invoice. | 10.75 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the platform. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the platform. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the platform. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the platform. | ABC Electronics |
| dsco_trading_partner_id | Integer | The identifier that the account has been identified with within the Trading Partner manager within the platform. | 123456 |
| dsco_trading_partner_name | String | The name that the account has been identified with within the Trading Partner manager within the platform. | ABC Electronics |
| dsco_original_order_retailer_create_date | Date-Time | Date the order was originally created in the retailer's order management system. | 2019-02-24T19:43:56+07:00 |
| dsco_invoice_create_date | Date-Time | The date that the invoice was originally created within the platform. | 2019-02-24T19:43:56+07:00 |
| dsco_invoice_last_update_date | Date-Time | The date that the invoice was last updated by the supplier. | 2019-02-24T19:43:56+07:00 |
| Field Name | Data Type | Field Description | Example |
| return_number | String | The unique return identifier for the given return. | abc1234 |
| dsco_order_id | String | Unique ID created within the platform. | abc1234 |
| po_number | String | The unique order identifier as provided by the retailer's ordering system. The po_number must exist within the supplier's Rithum account. | abc1234 |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. | 12345c |
| return_date | Date-Time | The date for the return, set by the creating partner on creation. | 2019-02-28T19:43:56+07:00 |
| return_reason | String | The reason the return was created. | Undeliverable |
| requested_action | String | Instructions regarding replacement, repair and/or handling of customer account. | Damaged goods, please dispose |
| return_tracking_numbers | String | The tracking numbers used by the sending party to return the items to the receiving party. Format : {carrier}::{tracking_number}^^{carrier}::{tracking_number} | ups::r_123456^^fedex::r_78910 |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| tracking_numbers_1 | String | The single tracking number used by the sending party to return the items to the receiving party. One return required per shipment. | t_123456 |
| tracking_numbers_2 | String | The single tracking number used by the sending party to return the items to the receiving party. One return required per shipment. | t_789123 |
| transaction_date | Date-Time | Date-Time of the return transaction. | 2023-05-01T00:00:00+00:00 |
| transaction_id | String | Assigned ID of the return transaction. | A123456 |
| dsco_line_item_item_id | Integer | The ID assigned by the platform for the given SKU within the platform. | 24152 |
| line_item_ean | String - EAN Format Enforced | EAN of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 8453287651234 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Field Limitations - GTIN = 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_isbn | String | ISBN of the line-items. Enforced 13-character formatting. | 9780399592522 |
| line_item_mpn | String | MPN of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | MPN-123-456 |
| line_item_partner_sku | String | Partner SKU of the item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 123_ps |
| line_item_sku | String | The SKU being referenced for this line_item record. This must match a SKU included in the original order within the platform. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | SKU123 |
| line_item_upc | String - UPC Format Enforced | UPC of the line item being returned. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 932123083564 |
| line_item_line_number | Integer | Line item number of the SKU on the order. This should match the line_item_line_number on the order and shipment. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
1 |
| line_item_quantity | Integer | Quantity of the line-item units being returned. | 1 |
| line_item_reason_code | String - Predefined Rithum codes are documented but users may set up a mapping to use their own codes. | The following codes will be accepted unless a code mapping has been configured within the account's mapping settings: CRP = Defective Product CRR = Customer Regret CRD = Damaged CRN = Product not as described CRU = Undeliverable |
CRR |
| line_item_adjustments | String | Tthe adjustments listed for the file. The format for this will be {adjustment reason}::{adjustment}^^{adjustment_reason_2::{adjustment} |
undeliverable::1^^damaged::0.50 |
| line_item_title_i18n_en_us | String | Title translation value for a given line on the return. The value in {locale} is the locale code (such as en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_america |
| line_item_title_i18n_en_ca | String | Title translation value for a given line on the return. The value in {locale} is the locale code (such as en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_other_locale |
| line_item_color | String | The color of the line item. | Blue |
| line_item_name | Integer | The name of the SKU. | 1 |
| line_item_personalization | String | Instructions for personalization. | Name “Frederick” to be embroidered on the left sleeve. |
| line_item_size | String | The size of the line item. | Large |
| line_item_title | String | The title of the SKU being ordered. If the option to create unknown SKUs is enabled, this title will be used as the new SKU's title. | SKU Title |
| line_item_retailer_item_ids_1 | String | The retailer-provided Retailer Item IDs for the item being returned. | lfg123 |
| line_item_retailer_item_ids_2 | String | The retailer-provided Retailer Item IDs for the item being returned. | lfg123 |
| Field Name | Data Type | Field Description | Example |
| dsco_return_id | String | The return_id assigned by the platform for the given return. | r2930840293842030099 |
| partner_return_number | String | Trading partner's unique return identifier for the return. One of the required return identifiers must be provided : dsco_return_id OR partner_return_number | abc1234 |
| return_number | String | The unique return identifier for the return | abc1234 |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| return_tracking_number | String | The single tracking number used by the sending party to return the items to the receiving party. One return required per shipment. | 1z938493393900999z999 |
| receipt_date | Date-Time | The date that the return was created | 2019-02-28T19:43:56+07:00 |
| package_ship_carrier | String | The carrier that is shipping the package. Either a carrier & method or a service_level_code are required. | FedEx |
| package_ship_method | String | The shipment method that the package was shipped. Either a carrier & method or a service_level_code are required. | Ground |
| package_shipping_service_level_code | String | Used in conjunction with ship_carrier and ship_method, this allows the retailer to pass their own code, or the code that the supplier is expecting, using a pre-defined code that is agreed to between the supplier and Retailer. Either a carrier & method or a service_level_code are required. | G1 |
| dsco_line_item_item_id | Integer | The item_id assigned by the platform for the given SKU within the platform. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 2315758 |
| line_item_ean | String - EAN Format Enforced | The European Article Number (EAN). EAN Format Enforced. Field Limitations - EAN = 8 or 13 digits. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 8453287651234 |
| line_item_mpn | String | Manufacturer Part Number. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | MPN-123-456 |
| line_item_partner_sku | String | Partner SKU of the item being invoiced. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 123_ps |
| line_item_line_number | Integer | Line item number of the SKU on the order. This should match the line_item_line_number on the order and shipment. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
1 |
| line_item_upc | String - UPC Format Enforced | The Universal Product Code (UPC). Field Limitations - UPC = 6 (UPC-E) or 12 (UPC-A) digits. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | 932123083564 |
| line_item_sku | String | The SKU being referenced for this line_item record. This must match a SKU included in the original order within Dsco. One of the following line-item identifiers must be provided: itemId, sku, partnerSku, upc, mpn, ean | SKU123 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Field Limitations - GTIN = 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_isbn | String | ISBN of the line-items. Enforced 13-character formatting. | 9780399592522 |
| line_item_quantity | Integer | The quantity of line_item_sku that is being invoiced. This is not a required field, but it is suggested that you include it. | 1 |
| line_item_adjustments | String | The adjustments listed for the file. The format for this will be {adjustment reason}::{adjustment}^^{adjustment_reason_2::{adjustment} | undeliverable::1^^damaged::0.50 |
| Field Name | Data Type | Field Description | Example |
| dsco_return_id | String | The Return ID assigned to the original return by the platform. One of the following fields are required: dsco_return_id OR return_number | rt659f1fb3b4dda671773365 |
| partner_return_number | String | Trading partner's unique return identifier for the return. | abc1234 |
| return_number | String | The unique return identifier for the given return. One of the following fields are required: dsco_return_id OR return_number | 123456 |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| dsco_account_id | Integer | The identifier of the account within the platform. | 1000000789 |
| Field Name | Data Type | Field Description | Example |
| dsco_return_id | String | The return_id assigned by the platform for the given return. | r2930840293842030099 |
| return_number | String | The unique return identifier for the return | abc1234 |
| partner_return_number | String | Trading partner's unique return identifier for the return. | abc1234 |
| po_number | String | The unique order identifier generated by the retailer's ordering system. | abc1234 |
| dsco_account_id | String | The account_id assigned by the platform for the given return. | 123 |
| dsco_trading_partner_id | String | The identifier that the platform may be able to identify the account the order should be sourced through using the Trading Partner ID set up within the Trading Partner manager. | 123 |
| response_reason | String | The detailed response from the trading partner. If this is provided on creation, it will be ignored. | Accepted |
| line_item_item_id | Integer | Line item ID on the order. | 1 |
| line_item_ean | String - EAN Format Enforced | The European Article Number (EAN). Field Limitations - EAN = 8 or 13 digits. | 8453287651234 |
| line_item_gtin | String - GTIN Format Enforced | The Global Trade Item Number (GTIN). Field Limitations - GTIN = 8, 12, 13 or 14 digits. | 00012345678905 |
| line_item_isbn | String | ISBN of the line-items. Enforced 13-character formatting. | 9780399592522 |
| line_item_mpn | String | Manufacturer Part Number | MPN-123-456 |
| line_item_partner_sku | String | Partner SKU of the item being invoiced. | 123_ps |
| line_item_sku | String | The SKU being referenced for this line_item record. This must match a SKU included in the original order within the platform. A limit of 70 characters is enforced. | SKU123 |
| line_item_upc | String - UPC Format Enforced | The Universal Product Code (UPC). Field Limitations - UPC = 6 (UPC-E) or 12 (UPC-A) digits. | 932123083564 |
| line_item_line_number | Integer | Line item number of the SKU on the order. This should match the line_item_line_number on the order and shipment. *Conditionally Required: If an order includes line_item_line_number fields, this field must be sent back for each line item in the shipment. |
1 |
| line_item_quantity | Integer | The quantity of line_item_sku that is being invoiced. This is not a required field, but it is suggested that you include it. | 1 |
| line_item_reason_code | String - Predefined Rithum codes are documented but users may set up a mapping to use their own codes. | Indicates the reason code for why the order line-item is being returned. Refer to the Order Return Mapping settings to customize the values you may use or view the current list of allowed codes. | CRR |
| line_item_adjustments | String | Tthe adjustments listed for the file. The format for this will be {adjustment reason}::{adjustment}^^{adjustment_reason_2::{adjustment} | undeliverable::1^^damaged::0.50 |
| line_item_title_i18n_en_us | String | Title translation value for a given line on the return. The value in {locale} is the locale code (such as en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_america |
| line_item_title_i18n_en_ca | String | Title translation value for a given line on the return. The value in {locale} is the locale code (such as en_us). The value is the translated value in the locale language of the original line_item_title value. | line_titl_other_locale |
| line_item_color | String | The color of the line item. | Blue |
| line_item_name | Integer | The name of the SKU. | 1 |
| line_item_personalization | String | Instructions for personalization. | Name “Frederick” to be embroidered on the left sleeve. |
| line_item_size | String | The size of the line item. | Large |
| line_item_title | String | The title of the SKU being ordered. If the option to create unknown SKUs is enabled, this title will be used as the new SKU's title. | SKU Title |
| line_item_retailer_item_ids_1 | String | Secondary part number included by the retailer. The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_retailer_item_ids_2 | String | Secondary part number included by the retailer. The platform can support up to three line_item_retailer_item_id_x fields per order. |
lfg123 |
| line_item_response | String | Response to the line-item return creation. Acceptable values are: accepted, rejected | accepted |
Comments
Please sign in to leave a comment.