CRUX Docs logo

Getting Started

Welcome to your file guide.

Here you will find details for our parameters we require, prefer, and desire in order to connect to both Supplier & Retailer. Additionally you have use case examples for everything from getting your product information into your catalog to submitting the invoice.


Submitting Files - FTP

Uploading Files

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory
Before Uploading
  • Proper naming Conventions for files
  • Character Encoding (UTF-8)
  • Line Delimiter (no carriage returns)

Fields

Required - You’d better have this, or don’t bother submitting.

Dependent - Required if related field has a value.

Preferred - We’d really like it if you provided these because it’s important.

Desired - It would be cool if you had these.


File Downloads

All File Downloads listed in this documentation


.xlsx File Samples

Product Data Files

Order Data Files


.csv File Samples

Product Data Files

Order Data Files

Submitting Product Information

How do I submit product information?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory

Notes

  • The default unit of measurement metric values are cm & g
  • item_attribute
    • Used when it’s a parent attribute. - e.g. features, or fabric
  • sku_distinguishing_attribute
    • Used when it’s an absolute variant on the parent object. - e.g. color or size
  • sku_nondistinguishing_attribute
    • Used when it’s at the sku level, but is a companion to an already distinguishing attribute. - e.g. you’ve set color as a sku_distinguishing_attribute, then color_code can be set to sku_distinguishing_attribute
item_id
title
sku_id
pricing.1.catalog
pricing.1.minimum_tier_quantity
pricing.1.cost
pricing.1.shipping_cost_is_estimate
warranty
return_policy
manufacturer
brand
country_of_origin
shipping_origin_country
categories
restrict_from_marketplaces
other_marketplace_restriction
fba_certified
restrictions
condition
quantity_in_stock
quantity_on_backorder
backorder_date
number_of_units_bundled
pricing.1.shipping_cost
pricing.1.shipping_cost_is_estimate
minimum_advertised_price
msrp
sku_weight
sku_weight_units
sku_length
sku_width
sku_height
sku_dimension_units
package_weight
package_weight_units
package_length
package_width
package_height
package_dimension_units
upca
ean13
gtin14
isbn
asin
mpn
product_images_for_item
product_images_for_sku
item_attribute.1.name
item_attribute.1.value
sku_distinguishing_attribute.1.name
sku_distinguishing_attribute.1.value
sku_nondistinguishing_attribute.1.name
sku_nondistinguishing_attribute.1.value
description

Update Inventory

How do I update inventory?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory

Notes

  • Include all three required fields.
item_id
sku_id
quantity_in_stock
backorder_date (required when using quantity_on_backorder)
quantity_on_backorder

Retrieve an Order

How do I retrieve an order?


File Sample


Retrieving Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Download

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Download order files inside /out directory

Retrieving Orders - Crux Website

  1. On the Dashboard, go to Orders Awaiting Allocation and click on an order.
    • or go to the Orders tab to view all open orders.
  2. To export one or more orders into a spreadsheet, select the checkbox next to the order then click on the red Export button at the top.

Allocating Line Items for Orders

How do I allocate line items on an order?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory

Submitting Allocation - Crux Website

  1. On the Dashboard, go to Orders Awaiting Allocation, click the order you wish to allocate
    • or go to the Allocate tab to view orders pending allocation.
  2. Enter the amount you are accepting under Amount Accepting
  3. If one or more items are on backorder, enter the amount under Amount Backordered; if there are no backordered items, enter 0. If available, provide the date that the backordered items will be available under Backordered Until. • To export one or more orders into a spreadsheet, select the checkbox next to the order and click on the red Export button at the top.
retailer_po
sku_id
---ONE-OF---
quantity_accepted
quantity_rejected
quantity_backordered
------------
backorder_date (to be used with quantity_backordered)
supplier_po
supplier_provided_notes
supplier_provided_order_attributes
supplier_provided_drop_ship_fee
supplier_provided_order_fee
supplier_provided_tax
supplier_provided_order_total
supplier_provided_sku_cost
supplier_provided_shipping_cost

Submitting Tracking Information

How do I submit tracking information


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory

Submitting Tracking - Crux Website

  1. On the Dashboard, go to Orders Awaiting Tracking and click on the order you wish to allocate
    • or go to the Orders tab then Add tracking tab that will appear underneath to view any orders pending tracking.
  2. Click on the order you wish to add tracking to and select Add Tracking. A sidebar will appear on the right.
  3. Enter tracking number under the box labeled Tracking Number.
  4. Enter the amount of items included in your shipment under Items included.
  5. Enter the cost of the shipment under Ship Cost.
  6. Enter the carrier name under Carrier.
  7. Enter the shipping method under Method.
  8. Provide the weight of the package under Weight.
  9. Submit by clicking Add tracking.
  10. To export one or more orders into a spreadsheet, select the checkbox next to the order and click on the red Export button at the top.
retailer_org_uuid
retailer_po
tracking_number
sku_id
quantity_shipped
supplier_provided_sku_cost
supplier_po
supplier_provided_notes
supplier_provided_order_attributes
supplier_provided_drop_ship_fee
supplier_provided_order_fee
supplier_provided_tax
supplier_provided_order_total
supplier_provided_shipping_cost

Submitting an Invoice

How do I submit an Invoice?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory
retailer_org_uuid
retailer_po
invoice_number
sku_id
quantity_invoiced
supplier_provided_sku_cost
supplier_provided_drop_ship_fee
supplier_provided_order_fee
supplier_provided_tax
supplier_provided_order_total
supplier_provided_shipping_cost

Update Order Fees

How do I update order fees?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory
supplier_po
supplier_provided_dropship_fee
supplier_provided_order_fee
supplier_provided_tax
supplier_provided_order_total

Adding Order/Line Item Attributes

How do I add order/line item attributes?


File Sample


Submitting Files - FTP

File Details

Naming convention

filetype_date.csv

filetype_date.xlsx

  • Character encoding (UTF-8)
  • Line Feed (\n) preferred
  • Proper naming conventions. (file names must not include spaces)

FTP Upload

  1. Create your file based on our sample files and specs, including all required fields.
  2. Log into your Crux-provided FTP
  3. Upload file inside /in directory
retailer_org_uuid
retailer_po
supplier_provided_notes
supplier_provided_order_attributes
sku_id
supplier_provided_order_line_item_attributes

Product

The Product file covers both the item(Parent) & sku(Child) catalog information.

Parameters
item_id
(string) Required Unique identifier for the parent product.
sku_id
(string) Required Name of the product.
title
(string) Required Summary of the product information and/or specifications. Valid HTML is allowed, ensure that all tags are closed.
warranty
(string) Product specific warranty.
return_policy
(string) Rules to establish a process in which customers can return or exchange unwanted or defective items.
manufacturer
(string) Manufacturer of the product.
brand
(string) Brand name of the product.
country_of_origin
(string, ISO Alpha-2) The country where the product was manufactured. Must be a 2-digit ISO country code.
shipping_origin_country
(string, ISO Alpha-2) The country where the product is shipping from. Must be a 2-digit ISO country code.
categories
(array) The division in which items are organized based on shared characteristics.

> = Category Path Separator

| = Category Separator

Parameters
restrict_from_marketplaces
(string) Marketplaces in which the item can not be listed.
Values:
  • amazon
  • ebay
  • newegg
  • overstock
  • walmart
other_marketplace_restrictions
(string) Marketplaces that items cannot be listed and don’t fit in the accepted values of restrict_from_marketplaces field.
fba_certified
(boolean) Fulfillment by Amazon ceritifed.
restrictions
(string) Current status of the product if it is not in stock. Accepted Values below
condition
(string) The state in which the item is being sold in.
quantity_in_stock
(integer) Quantity currently available to be shipped
quantity_on_backorder
(integer) Current order of a product that is out of stock
backorder_date
(string) Date that the Backordered SKU will be available for shipment. This date should be used as a tentative schedule which may help determine if waiting for the order is appropriate. Should this date be unacceptable, you may cancel the order with the “Cancel Order” API call.
number_of_units_bundled
(integer) The combined amount of units in the product bundle
pricing.1.catalog
(string, alphanumeric, underscores) Required Used to organize the product into a particular catalog.
pricing.1.minimum_tier_quantity
(integer) Required
pricing.1.cost
(float) Required Cost of the product.
pricing.1.shipping_cost
(float) Cost to ship the packaged product.
pricing.1.shipping_cost_is_estimate
(boolean) true or false value to indict if the cost is actual or estimated.
minimum_advertised_price
(float) The lowest price a retailer can advertise the product for sale
msrp
(float) Manufacturer’s Suggested Retail Price is the price at which the manufacturer recommends that the retailer sell the product.
sku_weight
(float) The product weight.
sku_weight_units
(string) The unit of measurement used to provide a weight value to the sku_weight field.
sku_length
(float) The length of the product.
sku_width
(float) The width of the product.
sku_height
(float) The height of the product.
sku_dimension_units
(string) The unit of measurement used to provide the length, width, and height of the product.
Values:
  • Default: cm
  • m
  • in
  • ft
package_weight
(float) The weight of the product when packaged for shipping.
package_weight_units
(string) The unit of measurement used to provide a weight value to the package_weight field.
package_length
(float) The length of the product when packaged for shipping.
package_width
(float) The width of the product when packaged for shipping.
package_height
(float) The height of the product when packaged for shipping.
package_dimension_units
(string) The unit of measurement used to provide the length, width, and height of the product.
upca
(string) UPC-A consists of 12 numeric digits, that are uniquely assigned to each trade item.
ean13
(string) The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes; typically, the EAN is printed on a product label or packaging as a bar code.
gtin14
(string) The GTIN is a globally unique 14-digit number used to identify trade items, products, or services.
isbn
(string) The International Standard Book Number (ISBN) is a unique numeric commercial book identifier. An ISBN is assigned to each edition and variation (except reprintings) of a book.
asin
(string) Amazon Standard Identification Number. It’s a 10-charcter alphanumeric unique identifier that’s assigned by Amazon.com and its partners. It’s used for product-identification within Amazon.com organization. ASINs are only guaranteed unique within a marketplace.
mpn
(string) A manufacturer part number is a series of numbers and/or letters that has been given to a part by the manufacturer. An MPN identifies the part as belonging to and originating from that one manufacturer. Each part the manufacturer makes has a different MPN.
product_images_for_item
(string) Image provide to offer a visual of the product. Duplicate URLs across a sku or item will reference the same Product Image.
product_images_for_sku
(string) Image provide to offer a visual of the product. Duplicate URLs across a sku or item will reference the same Product Image.
description
(string) Summary of the product information and/or specifications. Valid HTML is allowed, ensure that all tags are closed.

Parameters
item_attribute.1.name
(string) Name used for a parent attribute. - e.g. features, or fabric
item_attribute.1.value
(string) Value used for a parent attribute. - e.g. wireless, or linen

20 item_attribute fields must be present.

Parameters
sku_distinguishing_attribute.1.name
(string) Name used when it’s an absolute variant on the parent object. - e.g. color or size
sku_distinguishing_attribute.1.value
(string) Value used when it’s an absolute variant on the parent object. - e.g. green or medium

5 sku_distinguishing_attribute fields must be present.

Parameters
sku_nondistinguishing_attribute.1.name
(string) Name used when it’s at the sku level, but is a companion to an already distinguishing attribute. - e.g. you’ve set color as a sku_distinguishing_attribute, then color_code can be set to sku_distinguishing_attribute
sku_nondistinguishing_attribute.1.value
(string) Value used when it’s at the sku level, but is a companion to an already distinguishing attribute. - e.g. you’ve set color as a sku_distinguishing_attribute, then color_code can be set to sku_distinguishing_attribute

10 sku_nondistinguishing_attribute fields must be present.

Inventory

The Inventory file covers what is needed to update a products inventory.

Parameters
item_id
(string) Required Unique identifier for the parent product.
sku_id
(string) Required sku as provided by the Supplier
quantity_in_stock
(integer) Required Quantity currently available to be shipped

Allocation

Parameters
retailer_org_uuid
(string) Universal Unique Identifier for the Line Item
retailer_po
(string) Required The Purchase Order ID that you provide to identify your order
sku_id
(string) Required Name of the product.
quantity_accepted
(object) Required The Quantity Accepted by the supplier
quantity_rejected
(integer) Required Quantity Rejected by the Supplier is the Quantity that they cannot fulfill.
quantity_backordered
(integer) Current order of a product that is out of stock
backorder_date
(string) Date that the Backordered SKU will be available for shipment. This date should be used as a tentative schedule which may help determine if waiting for the order is appropriate. Should this date be unacceptable, you may cancel the order with the “Cancel Order” API call.
supplier_po
(string) Required The Purchase Order ID that you provide to identify your order
supplier_provided_notes
(string) Supplier provided notes
supplier_provided_order_attributes
(array) Array of supplier provided Order Attribute objects
supplier_provided_line_item_attributes
(array) Array of supplier provided Line Item objects
supplier_provided_drop_ship_fee
(decimal) Supplier provided dropship fee (2 decimal places)
supplier_provided_order_fee
(decimal) Supplier provided order fee (2 decimal places)
supplier_provided_tax
(decimal) Supplier provided tax (2 decimal places)
supplier_provided_order_total
(decimal) Supplier provided order total (2 decimal places)
supplier_provided_sku_cost
(decimal) Supplier provided SKU cost (2 decimal places)
supplier_provided_shipping_cost
(decimal) Supplier provided shipping cost (2 decimal places)

Tracking

The Tracking section

Parameters
retailer_org_uuid
(string) Required Retailers Organization Universal Unique Identifier for the organization
retailer_po
(string) Required Retailer provided purchase order number
tracking_number
(string) Required Order tracking number
sku_id
(string) Required The SKU Identifier for the SKU as provided by the Supplier
quantity_shipped
(integer) Quantity shipped
supplier_provided_sku_cost
(decimal) Supplier provided SKU cost (2 decimal places)
supplier_po
(string) Supplier provided purchase order number
supplier_provided_notes
(string) Supplier provided notes
supplier_provided_order_attributes
(array) Array of supplier provided Order Attribute objects
supplier_provided_line_item_attributes
(array) Array of supplier provided Line Item objects
supplier_provided_drop_ship_fee
(decimal) Supplier provided dropship fee (2 decimal places)
supplier_provided_order_fee
(decimal) Supplier provided order fee (2 decimal places)
supplier_provided_tax
(decimal) Supplier provided tax (2 decimal places)
supplier_provided_order_total
(decimal) Supplier provided (2 decimal places)
supplier_provided_shipping_cost
(decimal) Retailer provided shipping cost (2 decimal places)

Invoice

Parameters
retailer_org_uuid
(string) Required Universal Unique Identifier for the Line Item.
retailer_po
(string) Required The Purchase Order ID that you provide to identify your order.
invoice_number
(string) Required Invoice number.
sku_id
(string) Required Name of the product.
quantity_invoiced
(integer) Required Quantity invoiced.
supplier_provided_notes
(string) Supplier provided notes
supplier_provided_order_attributes
(array) Array of supplier provided Order Attribute objects
supplier_provided_line_item_attributes
(array) Array of supplier provided Line Item objects
supplier_provided_sku_cost
(decimal) Required Supplier provided SKU cost (2 decimal places)
supplier_provided_drop_ship_fee
(float) Supplier provided dropship fee
supplier_provided_order_fee
(float) Supplier provided order fee
supplier_provided_tax
(float) Supplier provided tax
supplier_provided_order_total
(float) Supplier provided order total
supplier_provided_shipping_cost
(float) Supplier provided shipping cost

Fees

Parameters
supplier_po
(string) Required Supplier provided purchase order number
supplier_provided_drop_ship_fee
(decimal) Supplier provided drop ship fee (2 decimal positions)
supplier_provided_order_fee
(decimal) Supplier provided order fee (2 decimal places)
supplier_provided_tax
(decimal) Supplier provided tax (2 decimal places)
supplier_provided_order_total
(decimal) Supplier provided (2 decimal places)