Dsco Data Schema
Dsco supports the following objects:
Example Files
Download the attachment below for example templates for every Dsco data object.
Table Definitions
|
Field Type |
Background Color |
Description |
| Required | Red | The field is required to be included for every record. All required fields are in bold text. |
| Recommended | Yellow | The field is suggested to be included for every record, as the inclusion of this data is typically needed by most parties. |
| Optional | White | The field can be included if available. |
| New - 2021 | Orange | The field was added during several 2021 Dsco Schema updates. |
Data Type Definitions
|
Data Type |
Description |
Example |
| String | A string can contain any set of characters. | Lenovo ThinkPad T410 |
| HTML | A string containing HTML markup. | The <strong>Lenovo 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 Dsco platform. They allow Dsco 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.
Dsco recommends 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 64 characters is enforced. Dsco detects and rejects the case of a long number being converted to scientific notation by MS Excel. Dsco also don't allow the first character of a sku to be a single-quote. The following characters are allowed: A-Z 0-9 . , : ; \' ` ~ # & _ ! ( ) - + / \ | ? |
SKU1234 |
| upc | String - UPC format enforced | The Universal Product Code (UPC). Must be either 6 or 12 characters. |
884942723438 |
| ean | String - EAN format enforced | The European Article Number. Must be either 8 or 13 characters. |
7321432654382 |
| mpn | String | The Manufacturer Part Number (MPN). A limit of 20 characters is enforced. |
28479UU |
| gtin | String | The Global Trade Item Number. Must be 8, 12, 13, or 14 characters. |
00012345678905 |
| isbn | String | The International Standard Book Number. Must be either 10 or 13 characters. |
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 on trading partner on Dsco, please use the partner_sku_map field to provide partner SKU's for all of your trading partners. |
abc1234 |
| partner_sku_map | String | A map of the dsco account ID and the SKU a trading partner uses to reference the item. Dsco requires either the dsco_retailer_id or the dsco_trading_partner_id and then the partner_sku. You only need to provide partner SKU's for those partners that require it. |
::p123::abc1234^^1000000002::::987zyx Format: A string containing dsco_retailer_id::dsco_trading_partner_id::partner_sku separated by ^^ for each retailer. Only dsco_retailer_id OR dsco_trading_partner_id needs to be included |
| brand | String | The name of the brand. |
ThinkPad |
| quantity_available | Integer | The quantity available for order. The amount in the warehouse ready for shipment. A negative number indicates quantity on backorder. | 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. | in-stock |
| 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 |
| unit_of_measure | Enum |
EA = Each PR = Pair CA = Case IG = Inner Package PL = Pallet |
CA |
| sales_cost_1 |
Float |
Amount the cost will be discounted to. |
1.23 |
| sales_price_1 |
Float |
Amount the sales price will be discounted to. |
1.23 |
| sales_start_date_1 |
Date-Time |
Date the sale will begin. |
2019-02-24T19:43:56+07:00 |
| sales_end_date_1 |
Date-Time |
Date the sale will end. |
2019-02-24T19:43:56+07:00 |
| warehouse_dsco_id_1 | String | This is an ID generated by Dsco when a warehouse is created within the system. |
|
| warehouse_code_1 |
String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * Dsco 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 system for suppliers to which they have access. |
Warehouse1 |
| warehouse_quantity_1 |
Interger | The quantity available in the specified warehouse. |
23 |
| warehouse_pick_location_1 | String | Bar-separated list of custom name/value pairs that define the physical in-store pick location for the item. Can be used by store employees to locate and pick the physical item to prepare for shipping. |
Department:Mens|Division:Shoes|Shelf:3 |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_product_id | Integer | The product_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_retailer_assortments | String | The assortments the SKU is assigned to within Dsco 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 Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the Dsco system. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the Dsco 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_name | String | The Name that the Dsco 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 Dsco. | 2019-02-24T19:43:56+07:00 |
| dsco_last_quantity_update_date | Date-Time | The date that the SKUs 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 although 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 some kind of time-stamp to your file after the prefix. Otherwise, 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 Dsco 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.
Catalog Schema
|
Field Name |
Data Type |
Field Description |
Example |
| sku | String | The SKU of the item. A limit of 64 characters is enforced. Dsco detects and rejects the case of a long number being converted to scientific notation by MS Excel. Dsco also don't allow the first character of a sku to be a single-quote. The following characters are allowed: A-Z 0-9 . , : ; \' ` ~ # & _ ! ( ) - + / \ | ? |
SKU1234 |
| upc | String - UPC format enforced | The Universal Product Code (UPC). Must be 6 or 12 characters. | 884942723438 |
| ean | String - EAN format enforced | The European Article Number. Must be 8 or 13 characters. | 0884942723438 |
| mpn | String | The Manufacturer Part Number (MPN). | 28479UU |
| gtin | String | The Global Trade Item Number. Must be 8, 12, 13, or 14 characters. | 00012345678905 |
| isbn | String | The International Standard Book Number. 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 on trading partner on Dsco, please use the partner_sku_map field to provide partner SKU's for all of your trading partners. |
abc1234 |
| partner_sku_map | String | A map of the dsco account ID and the SKU a trading partner uses to reference the item. Dsco requires either the dsco_retailer_id or the dsco_trading_partner_id and then the partner_sku. You only need to provide partner SKU's for those partners that require it. |
::p123::abc1234^^1000000002::::987zyx Format: A string containing dsco_retailer_id::dsco_trading_partner_id::partner_sku separated by ^^ for each retailer. Only dsco_retailer_id OR dsco_trading_partner_id needs to be included |
| 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 (e.g. 'Lenovo Thinkpad T410 Notebook'). | T410 Notebook |
| brand | String | The name of the brand. | ThinkPad |
| 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. | in-stock |
| 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 Dsco when a warehouse is created within the system. |
w5a735f8fb5484253102350 |
| warehouse_code_1 | String | When a supplier has multiple warehouses, these fields are used to specify quantity on a per-warehouse basis. * Dsco 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 system for suppliers to which they have access. |
Warehouse1 |
| warehouse_quantity_1 | Integer | The quantity available in the specified warehouse. | 54 |
| warehouse_pick_location_1 | String | Bar-separated list of custom name/value pairs that define the physical in-store pick location for the item. Can be used by store employees to locate and pick the physical item to prepare for shipping. |
Department:Mens|Division:Shoes|Shelf:3 |
| 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. | 10 |
| product_group | String | A group identifier that, when multiple SKU's have the same product_group, the SKU's are options/variants of each other. For example, if 5 SKU's 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. | 123456 |
| 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. | T-Shirt |
| product_status | String | The status of the product within the product life cycle. The default status is "pending" which informs their trading partner(s) that they are setting up a new product. When the status changes to "active", the trading partners are allowed to purchase the item. Additional details on product status can be reviewed here. |
active |
| product_availability_start_date |
Date-Time | The date the item can start being ordered. Dsco 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. Dsco 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>Lenovo ThinkPad T410 2516ADU Notebook</strong> is designed to enhance productivity and change the way that you work. The Lenovo ThinkPad T410 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. | Lenovo <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 Lenovo ThinkPad T410 2516ADU Notebook is designed to enhance productivity and change the way that you work. The Lenovo 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 Lenovo 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' * Dsco 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 |
| 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, you should 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 |
| category_i18n_x |
String | Additional translations of the category. When using this field, multiple unique column headers should be used for each language, with a matching value in the row. For example, if languages English and French were supported, the following column headers should be provided: category_i18n_en-us and category_i18n_fr-ca, with values in each row to match. |
Home and Garden|Lamps & Lighting|Table Lamps |
| assortments | String |
In May 2019, Dsco changed the "Catalogs" field to "Assortments" to provide clarity around collections of items that a supplier wishes to make available to a given group of retailers they work with. Suppliers can manage their assortments from within the Inventory page within the Dsco portal and can assign the assortments a trading partner has access to within the Trading Partner manager. The title of each assortment the SKU is assigned to with multiple assortments being separated by double caret "^^". |
Main Assortment^^Spring 2015 |
| locations_can_be_sold_country_1 |
String |
The locations where this item is allowed to be sold. |
US |
| locations_can_be_sold_regions_1 |
String |
The locations where this item is allowed to be sold. |
GA |
locations_can_be_sold_postal_codes_1 |
String |
The locations where this item is allowed to be sold. |
31907 |
| locations_cannot_be_sold_country_1 |
String |
The locations where this item is not allowed to be sold. |
US |
| locations_cannot_be_sold_regions_1 |
String | The locations where this item is not allowed to be sold. |
GA |
| locations_cannot_be_sold_postal_codes_1 |
String |
The locations where this item is not allowed to be sold. |
31907 |
| 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 | 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 | The Manufacturer's Recommended Retail Price (MSRP). | 24.55 |
| map | Currency | The Minimum Advertised Price (MAP). | 17.99 |
| manufacture_cost | Currency | The supplier's cost of the item. This value is only shared with Dsco, not to the suppliers trading partners. This allows Dsco to provide profit reports to suppliers. |
56.12 |
| handling_cost | Currency | The handling costs or fees that will be added to the order when this SKU is purchased. | 2.00 |
| 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 | The average cost to ship the SKU via postal service carriers such as USPS. | 3.00 |
| average_ground_carrier_service_cost | Currency | The average cost to ship the SKU via ground service carriers such as FedEx and UPS. | 5.00 |
| average_air_carrier_service_cost | Currency | The average cost to ship the SKU via air service carriers such as FedEx and UPS. | 8.00 |
| average_freight_carrier_service_cost | Currency | 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 |
| 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. * Dsco supports as many product_image's 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.dsco.io/images/SKU1234.jpg |
| image_name_1 | String | The name of the image, describing the content of the image. * Dsco supports as many image's 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.dsco.io/images/SKU1234.jpg |
| 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.dsco.io/images/SKU1234.jpg |
| 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.dsco.io/images/SKU1234.jpg |
| 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' | lb |
| 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' | in |
| 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. |
in |
| 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. |
lb |
| condition | String | The condition of the SKU. Options may include, but are not limited to: 'New', 'Refurbished', 'Used' (without the quotes). | 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 SKU's 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 | Money | The monetary amount the retailer will pay to the supplier when purchasing the item. Calculated as MSRP x Commission Percentage. |
5.23 |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_product_id | Integer | The product_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_retailer_assortments | String | The assortments the SKU is assigned to within Dsco 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 Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within Dsco. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the Dsco 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_name | String | The Name that the Dsco 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 Dsco. | 2015-02-28T06:00:00-07:00 |
| dsco_last_quantity_update_date | Date-Time | The date that the SKUs 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 SKUs 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 Dsco 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 we 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. Otherwise, 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 Dsco 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
Starting February 2018, Dsco is changing the way ship carriers and methods work when creating orders. Moving forward, one of the options below must be included for an order to be created in Dsco:
- 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. *Required when creating an order with personalized items. |
3 |
| line_item_line_number | Integer | Sequential number of the line item in the order. *Required when creating an order with personalized line items. |
1 |
| line_item_sku | String Limited | The SKU being ordered. A limit of 64 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 |
UPC of the line item. | 693212378432 |
| line_item_ean | String - EAN format enforced |
EAN of the line item. | 9032847321238 |
| 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. *Dsco 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_quantity | Integer | The quantity being ordered. | 1 |
| line_item_title | String | The title of the SKU being ordered. If the option to create unknown SKU's 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_unit_of_measure |
Enum |
EA = Each PR = Pair CA = Case IG = Inner Package PL = Pallet |
CA |
| line_item_expected_cost | Currency | The cost that the retailer expects to pay for the given SKU. | 21.23 |
| line_item_consumer_price | Currency | The price that the retailer charged their customer for the given SKU. | 24.95 |
| 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 new Dsco 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 system for suppliers to which they have access. |
Warehouse1 |
| line_item_warehouse_dsco_id |
String | This is an ID generated by Dsco when a warehouse is created within the system. |
w5a735f8fb5484253102350 |
| line_item_receipt_id | String |
Receipt ID for the line item. | 235235asdasdf |
| 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_packing_slip_message | String |
Specific message to include on the packing slip for the line item. | Sample packing slip message. |
| 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 purchase. | true |
| line_item_bogo_instructions | String | Instructions to include when this line item was part of a BOGO purchase. | This item was part of a BOGO purchase. |
| line_item_tax_percentage_x | Float | Tax percentage applied to the line item. | 6.5 |
| line_item_tax_type_code_x | String | Type of tax applied to the line item. | T1 |
| line_item_tax_amount_1 | Float | Tax amount calculated on the line item. |
3.75 |
| line_item_tax_jurisdiction_qualifier_1 |
Enum |
'Customer defined' 'Taxing Authority Code' 'State or Province' 'State Defined' 'Vendor defined' 'Vertex' |
Taxing Authority Code |
| line_item_tax_jurisdiction_1 |
String | Region or jurisdiction applied when calculating taxes for the line item. |
QST |
| line_item_tax_exempt_code_1 |
Enum |
'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/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 |
| tax_percentage_1 |
Float | Tax percentage applied to the order. | 2.75 |
| tax_type_code_1 |
String | Type of tax applied to the order. | T1 |
| tax_amount_1 |
Float | Tax amount calculated on the order. |
3.75 |
| tax_jurisdiction_qualifier_1 |
Enum |
'Customer defined' 'Taxing Authority Code' 'State or Province' 'State Defined' 'Vendor defined' 'Vertex' |
Taxing Authority Code |
| tax_jurisdiction_1 | String | Region or jurisdiction applied when calculating taxes for the line item. |
QST |
| tax_exempt_code_1 |
Enum |
'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' |
Exempt (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 |
| taxable_amount_of_sale |
Float-Money | Indicates the sale amount that was taxable. Sum of line-items. |
1.23 |
| amount_of_sales_tax_collected |
Float-Money |
Sum of the line-item amount of sales tax collected. |
1.23 |
| line_item_taxable_amount_of_sale |
Float-Money |
Indicates the sale amount that was taxable at the line-level. |
1.23 |
| line_item_amount_of_sales_tax_collected |
Float-Money |
The amount of sales tax collected for the given line-item. |
1.23 |
| 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_product_group |
String | Used to provide the Vendor Style Number/Product Group for the item. Usually included on the packing slip. |
UIE - 1235 - Red |
| line_item_expected_delivery_date |
Date-Time | Allows each item to have it's own expected_delivery_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_required_delivery_date |
Date-Time |
Allows each item to have it's own required_delivery_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_acknowledge_by_date |
Date-Time |
Allows each item to have it's own acknowledge_by_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_cancel_after_date |
Date-Time |
Allows each item to have it's own cancel_after_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_ship_by_date |
Date-Time |
Allows each item to have it's own ship_by_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_invoice_by_date |
Date-Time |
Allows each item to have it's own invoice_by_date. If a line-item date is not provided the one at the order level will be used. |
2020-04-12T13:45:00Z |
| line_item_gtin |
String | Allows ordering an item based on the GTIN of the item similar to UPC and EAN. |
12345678901234 |
| line_item_returns_message_i18n_x |
String | Additional translations of the returns message. When using this field, multiple unique column headers should be used for each language, with a matching value in the row. For example, if languages English and French were supported, the following column headers should be provided: line_item_returns_message_i18n_en-us and line_item_returns_message_i18n_fr-ca, with values in each row to match. |
Return to the store. |
| line_item_title_i18n_x |
String | Additional translations of the title. When using this field, multiple unique column headers should be used for each language, with a matching value in the row. For example, if languages English and French were supported, the following column headers should be provided: line_item_title_i18n_en-us and line_item_title_i18n_fr-ca, with values in each row to match. |
Product title |
| 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 system for suppliers they have access to. |
Warehouse1 |
| requested_warehouse_dsco_id |
String | This is an ID generated by Dsco 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 |
| 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 |
| ship_attention | String | The name or title of the customer to whom the order is being shipped. | Jeremy |
| ship_name | String | Complete full name of the person to which the package will be shipped. |
Mr. John Doe Sr. |
| ship_first_name | String | First name of the customer to whom the order is being shipped. | Frederick |
| ship_last_name | String | Last name of the customer to whom the order is being shipped. | Von Giezer |
| ship_company | String | The company name of the customer to whom the order is being shipped. | Company Name LLC |
| ship_address | Array of Strings | Complete full address (with all lines) of the location to which the package will be shipped. |
1234 Main St. Apt 1 |
| ship_address_type |
String-Enum | 'Residential' or 'Commercial' |
Commercial |
| ship_address_1 | String | Address 1 line of the customer to whom the order is being shipped. | 123 North 456 West |
| ship_address_2 | String | Address 2 line of the customer to whom the order is being shipped. | Apt. 2b |
| 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_country | String | Shipping country of the customer to whom the order is being shipped using the two-character ISO country code. | US |
| ship_phone | String | Phone number of the customer to whom the order is being shipped. | 1234567890 |
| 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. *Conditionally Required. See note at the top of the order schema for details. |
UPS |
| ship_method | String | Shipping method requested. Only those options supported by the supplier will be supported. *Conditionally Required. See note at the top of the order schema for details. |
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. *Conditionally Required. See note at the top of the order schema for details. |
G1 |
| expected_delivery_date | Date-Time |
Expected Delivery Date - When the customer expects to get the package - on-or-before. *Conditionally Required. See note at the top of the order schema for details. **New January 2018 |
2019-02-24T19:43:56+07:00 |
| required_delivery_date | Date-Time |
Required Delivery Date - The package needs to arrive on this exact date, not before or after. *Conditionally Required. See note at the top of the order schema for details. **New January 2018 |
2019-02-24T19:43:56+07:00 |
| signature_required_flag | Bool | Is a signature required upon delivery? | 1 |
| ship_instructions | String | Allows for specific direction when the order is delivered. | Deliver to the side door. |
| retailer_create_date | Date-time | The time-stamp of when the order was originally created in the retailer's system. | 2019-02-24T19:43:56+07:00 |
| channel | String | Channel allows retailers to specify which of their channels this order was sourced from. For example, if the retailer has two eCommerce channels it is helpful if we know which channel each order came from so that we can return shipment data to the appropriate channel via an automated export. | MAGENTO |
| test_flag | Bool | When set to TRUE (1), the order will be designated as a "test" order. Retailers and suppliers will be able to filter on this flag within the portal and suppliers can include these orders within their automated or manual Order exports by specifying that they want test orders to be included. When set to FALSE (0) or not provided in the feed, the order will be considered a "live" order. |
1 |
| consumer_order_number | String | The identifier that was generated by the eCommerce system that identifies the order to the specific consumer order. This field is optional. |
123456 |
| currency_code | String | The 3 letter ISO 4217 currency code. |
USD |
| marketing_message | String | Marketing Message - for the packing slip. |
Please buy more from us. |
| packing_slip_message | String | A message to include for the entire packing slip. |
Please enjoy your items! |
| packing_instructions | String | Instructions on how to package the item. | Pack it up real nice and tight. |
| 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. Yay! |
| gift_flag | Bool | Indicates whether or not the order should be treated as a gift purchase. | 1 |
| 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 bat mitzvah. |
| 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 |
| gift_receipt_id | String | Gift receipt ID for the order. |
2452322asdfg |
| shipping_surcharge | Float | Surcharge applied to ship the order. | 2.53 |
| tax_percentage_x | Float | Percentage of tax applied to the order. | 6.5 |
| tax_type_code_x | String |
Type of tax applied to the order. | T1 |
| coupon_amount_x | Float | Discount amount applied by the coupon. | 25.5 |
| coupon_percentage_x | Float | Discount percentage applied by the coupon. | 6.54 |
| payment_card_type_x | String |
Type of payment card used by the customer. | VISA |
| payment_card_last_four_x | String |
Last 4 digits of the payment card. | 3432 |
| bill_to_attention | String |
The bill-to attention name for the order. | Johnny Walker |
| bill_to_name | String | Complete full name of the person to which the purchase was charged. |
Mr. John Doe Sr. |
| 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 |
Array of Strings |
Complete full address (with all lines) of the location to which the purchase was charged. |
1234 Main St. Apt 1 |
| bill_to_address_type |
String-Enum |
'Residential' or 'Commercial' |
Commercial |
| 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_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 address supplied by the customer. | email@dsco.io |
| acknowledge_by_date | Date-Time |
The date by which the order should be acknowledged. | 2019-02-24T19: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-24T19:43:56+07:00 |
| invoice_by_date | Date-Time |
The date by which an invoice should be sent to Dsco. | 2019-02-24T19:43:56+07:00 |
| dsco_ship_carrier | String |
The shipping carrier, as calculated by Dsco.Dsco 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 Dsco. Dsco 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 Dsco. Dsco 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 |
| retailer_accounts_payable_id |
String | Indicates the Retailers identifier for the accounts payable department that the supplier should utilize when submitting billing/invoice information. |
AB123 |
| authorization_for_expense_number |
String | Authorization for Expense (AFE) Number - The AFE number the supplier can use within their billing/invoicing process. |
XYZ654 |
| customer_membership_id |
String | The Customer Membership ID that the retailer uses to track the purchaser. This information is mostly used within the packing slip. |
987GHS |
| release_number |
String | The release number issued by the retailer for the given order for inclusion on the packing slip. |
UIO5564 |
| order_total_amount |
Currency |
Used to indicate the full cost of the order, including all line-item costs and associated fees. SAC*C*ZZZZ***order_total_amount |
65.42 |
| shipping_account_number |
String | Used to provide the shipping account number for the carrier that is indicated should be shipped through. ITAGroup wants to use this field to allow their customer to provide them with the carrier account number that they would like the shipment to be shipped through so that they are billed instead of ITAGroup or the supplier. The actual customer wants their shipping account to be billed. This field could also be used by other retailers to inform their supplier which account number to ship against in the case that it needs to be different than the account number that is already set up with their relationship. |
ABC-44579 |
| internal_control_number |
String | Used to indicate the CommerceHub internal control number for the order. | 123456 |
| order_type | Enum |
Used to indicate whether an order is 'drop ship/stand alone' or a 're-order' or a wholesale order. "Dropship" "Wholesale" |
Dropship |
| buyer_name |
String | Buyer name. | Frederick Von Giezer |
| buyer_attention |
String |
Buyer attention. |
Frederick Von Giezer |
| buyer_company |
String |
Buyer company. |
Company Name LLC |
| buyer_address_1 |
String |
Buyer address 1. |
123 North 456 West |
| buyer_city |
String |
Buyer city. |
Mobile |
| buyer_region |
String |
Buyer region. |
GA |
| buyer_postal |
String |
Buyer postal. |
31907 |
| buyer_country |
String |
Buyer country. |
US |
| buyer_phone |
String |
Buyer phone. |
8075551232 |
| buyer_email |
String |
Buyer email. |
email@dsco.io |
| buyer_tax_registration_number |
String |
Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. |
123456 |
| dsco_order_id | Integer | The Order ID assigned by Dsco for the given Order within Dsco. | 2315758 |
| dsco_order_status | String | The Status of the Order assigned by Dsco. | Created, Shipment Pending, Shipped, Cancelled |
| dsco_lifecycle |
String | Indicates the lifecycle status of the order. Additional details and explanation provided here. |
Received, Created, Acknowledged, Completed |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the Dsco system. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the Dsco. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the Dsco system. | ABC Electronics |
| dsco_trading_partner_parent_id |
String | Most retailers have two levels of identification for a supplier. The first is the vendor_id and the other is the parent_id. Nordstrom, THD and DSW all need this parent ID for things like item-setup or invoicing. |
123456 |
| dsco_trading_partner_id | String | The identifier that the Dsco 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_name | String | The Name that the Dsco 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 order was originally created within Dsco. | 2019-02-24T19:43:56+07:00 |
| dsco_last_update_date | Date-Time | The date that the order 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 although 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 Dsco will follow these file naming rules:
- Start (prefix) with "Order_"
- 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: 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. 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. See below for Line Item Status Reasons. | No line-items are shippable. |
| number_of_line_items | Integer | Number of line-items being cancelled. |
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 64 characters is enforced. | SKU1234 |
| line_item_upc | String - UPC format enforced | Line-Item UPC | 438203798321 |
| line_item_ean | String - EAN format enforced | Line-Item EAN | 8490321480321 |
| line_item_partner_sku | String | Partner SKU | abc1234 |
| line_item_retailer_item_id_1 | String | Secondary part number included by the retailer. *Dsco 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_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_status_quantity | Integer | Quantity of the status being updated. | 3 |
| line_item_original_order_quantity | Integer | Line-Item Original Order Quantity | 3 |
| line_item_cancel_code | String | Indicates the reason code for why the order line-item is being cancelled. Refer to Dsco's 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. See below for Line Item Status Reasons. | out-of-stock |
| line_item_unit_of_measure |
Enum |
EA = Each PR = Pair CA = Case IG = Inner Package PL = Pallet |
EA |
| 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. This field is optional. |
12345 |
| dsco_order_id | Integer | The Order ID assigned by Dsco for the given Order within Dsco. 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 Dsco. | Shipment Pending |
| dsco_lifecycle | String | Indicates the lifecycle status of the order. Additional details are provided here. |
Received, Created, Acknowledged, Completed |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the Dsco system. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the Dsco. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the Dsco system. | ABC Electronics |
| dsco_trading_partner_id | Integer | The identifier that the Dsco 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_name | String | The Name that the Dsco 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 Dsco. | 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 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 Dsco will follow these file naming rules:
- Start (prefix) with "Order_Cancel_"
- Next, we 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
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. | FedEx |
| package_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. Go here for a complete list of shipping codes supported by Dsco and information on customizing the default options. |
G1 |
| package_ship_cost | Currency | The cost to ship the package. | 14.50 |
| package_weight | Float | The total weight of the shipment. | 2.75 |
| package_weight_units | Weight-Unit | The units used to qualify the weight value given in the package_weight field. Must be one of the following: 'oz', 'g', 'lb' or 'kg'. |
lb |
| package_ship_date | Date-Time | The date that the given package shipped. | 2019-02-24T19:43:56+07:00 |
| package_sscc_barcode | String | Serial Shipping Container Code (SSCC) barcode of the package. | 00123356789067845678 |
| package_warehouse_code |
String | The suppliers’ code for the warehouse from which the order shipped. |
Warehouse1 |
| package_warehouse_retailer_code |
String | The retailers’ code for the warehouse from which the order shipped. |
Warehouse1 |
| package_warehouse_dsco_id |
String | The Dsco 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 system for suppliers to which they have access. |
Warehouse1 |
| requested_warehouse_dsco_id |
String | This is an ID generated by Dsco 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 |
| ship_warehouse_code | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. This value is mapped to the account's intended value using shipping code mappings available on the account that is performing the export. |
Warehouse1 |
| ship_warehouse_retailer_code | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. This value is mapped to the account's intended value using shipping code mappings available on the account that is performing the export. |
Warehouse1 |
| ship_warehouse_dsco_id | String | This is a derived value based on what was requested by the retailer and what Shipping Science recommended. This value is mapped to the account's intended value using shipping code mappings available on the account that is performing the export. |
w5a735f8fb5484253102350 |
| number_of_line_items | Integer | Total quantity of items in the shipment. This may different from the number of line items on the order if items are being shipped in multiple packages. | 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 64 characters is enforced. | SKU123 |
| line_item_upc | String - UPC format enforced |
UPC of the line item. |
876123432912 |
| line_item_ean | String - EAN format enforced |
EAN of the line item. |
8932143245674 |
| 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. *Dsco 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_unit_of_measure |
Enum |
EA = Each PR = Pair CA = Case IG = Inner Package PL = Pallet |
CA |
| line_item_quantity | Integer | The quantity that has shipped in this package. | 1 |
| line_item_original_quantity | Integer |
The original quantity of items 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. |
Lifetime Products |
| 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 |
| currency_code | String | The 3 letter ISO 4217 currency code. |
USD |
| ship_to_attention | String |
Ship-to attention line. | Barbara Jones |
| 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_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 |
Customer's country location. | US |
| ship_to_phone | String |
Customer's phone number. | 8018018014 |
| ship_to_email | String |
Customer's email address. | email@dsco.io |
| ship_to_store_number | String |
Store number to which the order is being shipped. | B12 |
| ship_from_attention | String |
Ship-from attention line. | Johnny Walker |
| ship_from_first_name | String |
Ship-from first name. | Frederick |
| ship_from_last_name | String |
Ship-from last name. | Von Geizer III |
| ship_from_company | String |
Ship-from company name. | Gadget Inc |
| ship_from_address_1 | String |
Ship-from first address line. | 123 North 321 West |
| ship_from_address_2 | String |
Ship-from second address line. | Suite 2B |
| ship_from_city | String |
Ship-from city. | Delta |
| ship_from_region | String |
Ship-from region (state in the US). | UT |
| ship_from_postal | String |
Ship-from postal code (ZIP code in the US). | 84321 |
| ship_from_country | String |
Ship-from country. | 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@dsco.io |
| ship_from_location_code | String |
Location code from which the order was shipped. | ABC123 |
| dsco_ship_carrier | String |
The shipping carrier, as calculated by Dsco. |
FedEx |
| dsco_ship_method | String |
The shipping method, as calculated by Dsco. |
Ground |
| dsco_shipping_service_level_code | String |
The shipping service level, as calculated by Dsco. |
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 |
| dsco_actual_ship_carrier | String |
Carrier Dsco recorded as the actual carrier used when shipping the order. | USPS |
| dsco_actual_ship_method | String |
Shipping method Dsco recorded as the actual method used when shipping the order. | Overnight |
| dsco_actual_shipping_service_level_code | String |
Shipping service level code Dsco recorded as the actual service level used when shipping the order. | FE2D |
| dsco_actual_ship_cost | Currency | Cost Dsco recorded as the actual cost of shipping the order. | 12.54 |
| dsco_actual_delivery_date | Date-Time |
Date Dsco recorded as the actual delivery date of the package. | 2019-02-24T19:43:56+07:00 |
| dsco_actual_pickup_date | Date-Time |
Date Dsco 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 Dsco for the given tracking or package within Dsco. | 123456789 |
| dsco_order_id | Integer | The Order ID assigned by Dsco for the given Order within Dsco. | 2315758 |
| dsco_order_status | String | The Status of the Order assigned by Dsco. | Shipment Pending |
| dsco_lifecycle | String | Indicates the lifecycle status of the order. Additional details are provided here. |
Received, Created, Acknowledged, Completed |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_supplier_id | Integer | The supplier identifier of the given supplier within the Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the Dsco system. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the Dsco. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the Dsco system. | ABC Electronics |
| dsco_trading_partner_id | String | The identifier that the Dsco 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_name | String | The Name that the Dsco 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 Dsco. | 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 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 Dsco will follow these file naming rules:
- Start (prefix) with "Order_Shipment_"
- Next, we 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 9 fields below can simply be included in the shipment file when submitting information for a returned shipment.
|
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. *Dsco 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. |
Lifetime 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 Dsco account, meaning that an Invoice ID cannot be used more than once. This is a required field. | 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 Dsco account. This is a required field. | 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. This is a required field. | 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, Dsco will use the current date as the invoice date. | 2019-02-24T19:43:56+07:00 |
| remit_to_name |
String | Remit to name. | Frederick Von Giezer |
| remit_to_attention |
String |
Remit to attention. |
Frederick Von Giezer |
| remit_to_company |
String |
Remit to company. |
Company Name LLC |
| remit_to_address_1 |
String |
Remit to address 1. | 123 North 456 West |
| remit_to_city |
String |
Remit to city. |
Mobile |
| remit_to_region |
String |
Remit to region. |
GA |
| remit_to_postal |
String |
Remit to postal. |
31907 |
| remit_to_country |
String |
Remit to country. |
US |
| remit_to_phone |
String |
Remit to phone. |
8075551232 |
| remit_to_email |
String |
Remit to email. |
email@dsco.io |
| remit_to_tax_exempt_number |
String |
Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. |
123456 |
| seller_name |
String |
Seller name. | Tom Jones |
| seller_attention |
String |
Seller attenion. |
Tom Jones |
| seller_company |
String |
Seller company. |
Company Name LLC |
| seller_address_1 |
String | Seller address 1. |
124 North 456 West |
| seller_city |
String |
Seller city. |
Mobile |
| seller_region |
String |
Seller region. |
TX |
| seller_postal |
String |
Seller postal. |
76244 |
| seller_country |
String |
Seller country. |
US |
| seller_phone |
String |
Seller phone. |
8075551238 |
| seller_email |
String |
Seller email. |
email1@email.com |
| seller_tax_registration_number |
String |
Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. |
123456 |
| buyer_name |
String |
Buyer name. | Barbara Jones |
| buyer_attention |
String |
Buyer attention. |
Barbara Jones |
| buyer_company |
String |
Buyer company. |
Company Name LLC |
| buyer_address_1 |
String |
Buyer address 1. |
125 North 456 West |
| buyer_city |
String |
Buyer city. |
Paris |
| buyer_region |
String | Buyer region. |
TX |
| buyer_postal |
String |
Buyer postal. |
75065 |
| buyer_country |
String |
Buyer country. |
US |
| buyer_phone |
String |
Buyer phone. |
8075551235 |
| buyer_email |
String |
Buyer email. |
email@email.com |
| buyer_tax_registration_number | String |
Tax ID number, provided by a registering body. Should be used in conjunction with other jurisdiction fields. |
123456 |
| invoice_currency_code | String | The 3 letter ISO 4217 currency code. | USD |
| invoice_subtotal_excluding_line_items | Currency | The sum of invoice_handling_amount, invoice_freight_amount and invoice_sales_tax_amount. | 40.00 |
| invoice_line_items_subtotal | Currency | The sum of all line_item_subtotal values. | 40.00 |
| invoice_handling_amount | Currency | The amount being charged for handling charges at the invoice level. | 40.00 |
| invoice_freight_amount | Currency | 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 | 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 |
| tax_amount_1 |
Float | Tax amount calculated on the order. |
2.75 |
| tax_jurisdiction_qualifier_1 |
Enum |
'Customer defined' 'Taxing Authority Code' 'State or Province' 'State Defined' 'Vendor defined' 'Vertex' |
Taxing Authority Code |
| tax_jurisdiction_1 |
String | Region or jurisdiction applied when calculating taxes for the order. |
QST |
| tax_exempt_code_1 |
Enum |
'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' |
Exempt (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 |
| invoice_number_of_line_items | Integer | The number of items being invoiced. This number may differ from the number of line items on the order if multiple invoices are being submitted for a single order. | 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 Dsco. This is not a required field, but it is suggested that you include it. A limit of 64 characters is enforced. | SKU123 |
| line_item_upc | String - UPC format enforced |
UPC of the line item being invoiced. | 932123083564 |
| line_item_ean | String - EAN format enforced |
EAN of the line item being invoiced. | 8453287651234 |
| 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. *Dsco 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. |
Lifetime 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 dsco internal code for the warehouse from which this line-item shipped. |
w5a735f8fb5484253102350 |
| line_item_requested_warehouse_dsco_id |
String | The dsco 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 | 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 | The amount of line_item_unit_price multiplied by line_item_quantity. | 12.50 |
| line_item_handling_amount | Currency | The total amount being charged for handling charges for this specific line_item_sku. | 12.50 |
| line_item_msrp |
Currency | 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 | 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. Shipping codes can be set up on your ship map settings in Dsco. Go here for a complete list of shipping codes supported by Dsco and information on customizing the default options. |
G1 |
| line_item_dsco_package_id |
Integer | Package ID generated by Dsco 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 | String | Unit of measurement for the weight of the item. | Kg |
| 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 | The amount being discounted for each line_item_sku for the given line_item_promotion_reference. | 12.50 |
| line_item_tax_amount | Currency | The amount of tax being charged for this line_item_sku. | 12.50 |
| amount_of_sales_tax_collected |
Float-Money | Sum of the line-item amount of sales tax collected. |
1.23 |
| taxable_amount_of_sale |
Float-Money |
Indicates the sale amount that was taxable. Sum of line-items. |
1.23 |
| line_item_taxable_amount_of_sale |
Float-Money |
Indicates the sale amount that was taxable at the line-level. |
1.23 |
| line_item_amount_of_sales_tax_collected |
Float-Money |
The amount of sales tax collected for the given line-item. |
1.23 |
| line_item_tax_amount_1 |
Float | Tax amount calculated on the line item. | 3.75 |
| line_item_tax_jurisdiction_qualifier_1 |
Enum |
'Customer defined' 'Taxing Authority Code' 'State or Province' 'State Defined' 'Vendor defined' 'Vertex' |
Taxing Authority Code |
| line_item_tax_jurisdiction_1 | String | Region or jurisdiction applied when calculating taxes for the line item. | QST |
| line_item_tax_exempt_code_1 |
Enum |
'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' |
No (Not Tax Exempt) |
| 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_subtotal | Currency | 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 | The amount being charged for invoice_charge_title_1. | 10.50 |
| invoice_charge_title_2 | String | A short explanation of the second 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 | The amount being charged for invoice_charge_title_2. | 3.50 |
| invoice_charge_title_3 | String | A short explanation of the third 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 | The amount being charged for invoice_charge_title_3. | 12.50 |
| invoice_total_amount_subject_to_terms_discount | Currency | The total amount being charged for all of the included charges. | 26.50 |
| invoice_terms_type | String | 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. **Either Net Due Date or Net Days should be included, but not both. |
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_type. **Either Net Due Date or Net Days should be included, but not both. |
15 |
| invoice_terms_discount_amount | Currency | 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 |
| ship_from_attention | String |
Name of the person shipping the item. | Bill Ing |
| ship_from_first_name | String | The first name from whom the package was shipped. | Frederick |
| ship_from_last_name | String | The last name from whom the package was shipped. | Von Giezer |
| ship_from_company | String | The company name from whom the package was shipped. | Company Name LLC |
| ship_from_address_1 | String | The main address from where the package was shipped. | 123 North 456 West |
| ship_from_address_2 | String | The secondary address from where the package was shipped. | Apt. 2b |
| ship_from_city | String | The city from where the package was shipped. | Fakeville |
| ship_from_region | String | The region from where the package was shipped. Within the United States, this is the State. | GA |
| ship_from_postal | String | The postal code from where the package was shipped. | 31907 |
| ship_from_country | String | The country code from where the package was shipped using the two-character ISO country code. If no country is provided, we will default it to "US". | US |
| ship_from_phone | String |
Phone number provided by the supplier shipping the package. | 8015431232 |
| ship_from_email | String |
Email provided by the supplier shipping the package. | ap@dsco.io |
| ship_from_location_code | String | The location code from where the package was shipped. | 1234 |
| ship_to_attention | String |
Name of the person included on the ATTN line of the order. | Bill Able |
| 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_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 we will default it to "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@dsco.io |
| ship_to_store_number | String |
Store number to which the order was shipped. | B12 |
| ship_number_of_units_shipped | Integer | The number of unit's 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 | Weight-Unit | 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 Dsco for the given tracking or package within Dsco. |
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_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 system for suppliers to which they have access. |
Warehouse1 |
| requested_warehouse_dsco_id |
String |
This is an ID generated by Dsco 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 |
| invoice_seller_invoice_number | String | The seller/supplier's Packing Slip Number, Picking Ticket Number or Control Number. | 12345 |
| order_type | Enum | Used to indicate whether an order is 'drop ship/stand alone' or a 're-order' or a wholesale order. “Dropship” “Wholesale” |
Dropship |
| 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 |
| dsco_invoice_id | Integer | The Invoice ID assigned by Dsco for the given Invoice within Dsco. | i1617d18cb03d5311612115 |
| dsco_order_id | Integer | The Order ID assigned by Dsco for the given Order within Dsco. | 2315758 |
| dsco_item_id | Integer | The item_id assigned by Dsco for the given SKU within Dsco. | 2315758 |
| dsco_invoice_status | Integer | The Status of the Invoice assigned by Dsco. | 2315758 |
| dsco_expected_line_item_amount | Currency | The subtotal amount for the line-item data as calculated by Dsco. | 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_amount | Currency | The total amount that was calculated using information pulled from the Dsco order. | 10.75 |
| 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 Dsco 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 Dsco. | 1000000789 |
| dsco_supplier_name | String | The name of the given supplier within the Dsco system. | ABC Electronics |
| dsco_retailer_id | Integer | The retailer identifier of the given retailer within the Dsco. | 1000000789 |
| dsco_retailer_name | String | The name of the given retailer within the Dsco system. | ABC Electronics |
| dsco_trading_partner_id | Integer | The identifier that the account has been identified with within the Trading Partner manager within the Dsco platform. | 123456 |
| 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_trading_partner_name | String | The name that the account has been identified with within the Trading Partner manager within the Dsco platform. | ABC Electronics |
| dsco_invoice_create_date | Date-Time | The date that the Invoice was originally created within Dsco. | 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 |
Comments
Please sign in to leave a comment.