Order Export

Summary of order export via flat file

Introduction

JOOR Order Integration (JOINT) is JOOR's standard flat file order export integration tool. We can fully customize the order export file through selecting the file format and which fields to include. Once the integration is live, orders can be manually or automatically selected to export to an FTP, or manually selected to download from the order list page.

Basic Requirements

  • Each file can contain one header row of field names, with each column representing one distinct order field.
  • We offer four common formats as file options: .csv, .txt, .xls, or .xlsx.
    • A delimiter is required for .csv and .txt files in order to separate out each of the fields in the export. This delimiter can be comma, pipe ("|"), semicolon, tab, or space.
  • Orders can be combined into a single flat file, one file per order, or sent as a .zip file.
  • Export file names can be configured to include information such as a PO number, customer code, or Unix timestamp.
  • Success and error reports based on the order export can be sent to specific email addresses.
  • After the export format has been created by JOOR, there are two methods to receive the order flat files:
    • Manually select the orders from the order list page and download in the selected format.
    • Schedule orders to export automatically to an FTP when they are assigned to specific statuses. The most common setting is for orders to export when they are marked as "Approved".

Tips

  • Please provide a sample file to which we can build. This will help us complete the custom format as efficiently and accurately as possible.
    • After the initial format is established, we will provide a test file for verification. After the format is approved, we will activate the orders integration.
  • We offer the use of a go-live date, which allows the integration to exclude orders created before a certain date. This helps to avoid creating duplicate orders, in case any orders have been previously entered into your system.
  • Orders can be set to export up to hourly through a customizable schedule.
  • JOOR uses 7 order statuses:
    • In Progress
    • Returned
    • Pending
    • Approved
    • Cancelled
    • Shipped
    • Notes
  • Most brands set the integration to export all orders when they reach the Approved status. However, we are able to customize this to trigger the export when orders reach any of these statuses.
  • After orders are exported through the integration, they will be marked as exported. Therefore, the next time the integration runs, they will not re-export.
    • If you would not like an order to export, you can mark it as Exported. It will then be ignored when the integration runs.
    • If an order has already been exported and you would like it to re-export, you can mark it as Force Export. It will then export the next time the integration runs.
  • If any fields are required, we are able to set up validation in the integration to fail unless those fields are populated.
    • Fields can also be made required without exporting in the file, if this is requested.

Order Export Fields

Field NameField LevelValue
account_idorderThe JOOR (retailer) account ID to which the order is assigned.
billing_cityorderThe city entered in the billing address by the rep/store on the order.
billing_codeorderThe Brand's code for unique billing addresses (often unused)
billing_companyorderThe store name entered in the billing address by the rep/store on the order.
billing_countryorderThe country name entered in the billing address by the rep/store on the order.
billing_country_code2orderThe 2-digit country code of the country entered in the billing address by the rep/store on the order.
billing_line1orderThe address line 1 entered in the billing address by the rep/store on the order.
billing_line2orderThe address line 2 entered in the billing address by the rep/store on the order.
billing_nameorderThe buyer/contact name entered in the billing address by the rep/store on the order.
billing_phoneorderThe phone number entered in the billing address by the rep/store on the order.
billing_stateorderThe state entered in the billing address by the rep/store on the order.
billing_ziporderThe postal code entered in the billing address by the rep/store on the order.
buyer_display_nameorderThe display name associated with the buyer's email address in JOOR.
buyer_phoneorderThe phone number associated with the buyer's email address in JOOR.
calculated_order_subtotalorderThe purchase order subtotal (sum of each item price * quantity).
calculated_order_totalorderThe purchase order subtotal + shipping price (less discounts).
commissionsorderSales Rep order commissions.
createdorderOrder created date (long format with timestamp).
currency_codeorderCurrency Code assigned to the order currency.
price_type_nameorderThe name of price type on order.
customer_codeorderUnique Customer Cude supplied by Brand for each retailer.
company_nameorderName of company placing the order.
company_codeorderCompany code of the company placing the order.
date_approvedorderOrder approved date (long format with timestamp).
designer_custom_urlorderBrand's custom URL.
designer_idorderThe JOOR (brand) account ID to which the order is assigned.
designer_payment_method_codeorderPayment method/terms code assigned to the order.
designer_profile_nameorderBrand Account Name as entered on JOOR.
designer_shipping_method_codeorderShipping method code assigned to the order.
discount_amountorderOrder level discount
division_codeorderOrder division code.
door_codesorderStyle Door Code - (each style is assigned a door)
door_namesorderStyle Door Name - (each style is assigned a door)
eventorderEvent (or "JOOR Site")
event_codeorderCode associated with the event name.
export_createdorderExport date (long format with timestamp).
export_descriptionorderExport status description (success or reasons for failure)
export_statusorder0 = pending export
1 = exported
2 = modified since exported
3 = failed
export_successorderExport success (true or false)
idorderJOOR style_color identifier
joor_web_status_idorderJOOR order status code
1 = In Progress
2 = Returned
3 = Pending
4 = Approved
5 = Cancelled
6 = On Hold
7 = Shipped
8 = Notes
modifiedorderOrder modified date (long format with timestamp)
order_typeorderDesigner order types
payment_method_nameorderPayment Method/Terms description assigned to the order
po_numorderCustomer defined Purchase Order number
public_idorderJOOR public order ID
public_status_idorderJOOR public order status ID
rep_cc_emailsorderIf the rep has a CC for their order
rep_send_ipad_emailsorderMy Settings > Send email for iPad orders
rep_user_emailorderSales rep email
retailer_profile_nameorderRetailer Account Name as entered on JOOR
sales_contactorderBrand user JOOR display name (or brand profile contact name)
sales_emailorderBrand user email (or brand profile email)
sales_phoneorderBrand user phone number (or brand profile phone number)
sales_rep_codeorderCode associated with Brand user
sales_rep_display_nameorderBrand user JOOR display name
sales_rep_phoneorderBrand user JOOR phone number
season_codeorderLinesheet Season Code
season_nameorderLinesheet Season Name
shipping_accountorderShipping Method Account # (e.g. UPS account #)
shipping_cityorderThe city entered in the shipping address by the rep/store on the order
shipping_codeorderThe Brand's code for unique shipping addresses
shipping_or_customer_codeorderDisplays customer code if no store code available
shipping_companyorderThe Store Name entered in the shipping address by the rep/store on the order
shipping_completeorderOrder stop ship date (long format with timestamp)
shipping_countryorderThe country entered in the shipping address by the rep/store on the order
shipping_country_code_2orderThe 2-digit country code of the country entered in the shipping address
shipping_emailorderThe email entered in the shipping address by the rep/store on the order
shipping_line1orderThe address 1 entered in the shipping address by the rep/store on the order
shipping_line2orderThe address 2 entered in the shipping address by the rep/store on the order
shipping_method_nameorderShipping Method description assigned to the order
shipping_nameorderThe buyer/contact name entered in the shipping address by the rep/store on the order
shipping_phoneorderThe phone entered in the shipping address by the rep/store on the order
shipping_priceorderThe shipping fee that can be assigned to the order
shipping_startorderOrder start ship date (long format with timestamp)
shipping_stateorderThe state entered in the shipping address by the rep/store on the order
shipping_ziporderThe postal code entered in the shipping address by the rep/store on the order
signature_fileorderOrder signature filepath
sourceorderJOORAccess (site) or JOOR Orders for iPad
special_instructionsorderOrder special instructions/comment field
internal_commentsorderComments only visible to the brand and not displayed on the PO
statusorderJOOR order status description
stylesorderConcatenation of all style data
tax_id_numberorderRetailer Tax ID
tax_labelorderTax Type Label (e.g. VAT)
termsorderTerms & Conditions (price type specific)
total_unitsorderTotal order unit quantity
type_codeorderOrder Type Code
warehouse_nameorderName of retailer warehouse
warehouse_codeorderCode associated with retailer warehouse
placeholderFree field to rename and use as needed. Could be used to hold a constant value.
placeholder.order_detail_row_counterOrder row/line number counter
concatenated_fieldsConcatenation of any two or more available fields with the option to select a specific delimiter type
active_linesheetsstyleIf YES, the style is still on a linesheet
If NO, the style is no longer on the linesheet
available_sizesstyleAll sizes the style is available in
country_of_originstyleCountry of Origin for style
division_codestyleOrder division code
silhouettestyleSilhouette of style
silhouette_codestyleCode associated with silhouette of style
fabricationstyleA style attribute for fabrication description
fabrication_codestyleCode associated with fabrication description
idstyleJOOR style_color identifier
imagestyleMain style image filepath
linesheet_namestyleLinesheet Name ordered off of
materialsstyleStyle Material description
namestyleSize name
numberstyleBrand Style Number
suggested_retail_pricestyleSuggested Retail Price
heel_heightstyleA Style attribute for the height of a heel that appears on the PO
source_of_materialsstyleSource of materials used in fabrication
contains_furstyleNotes if style contains fur
measurementsstyleMeasurements of the style
descriptionstyleDescription of the style
activecolorYES means the style color is still active
NO means the style color is deleted
codecolorColor Code
commentcolorStyle Color Comment
door_idcolorJOOR door ID
door_namecolorDoor Name
door_codecolorDoor Code
idcolorJOOR style_color identifier
imagecolorMain style image filepath
namecolorColor name
sizescolorAll sizes with unit counts for a particular style number and color
codesizeSize Code. This field should not be required for bulk orders as Bulk Sizing will not have a size code.
item_pricesizeLine item wholesale price
item_price_adjustmentsizeDifference between line item "original price" and item "current price"
item_price_extendedsizeLine item price multiplied by line item quantity
color_commentsizeComment added on color
modificationssizeStyle order comment
original_pricesizeOriginal Item Price
quantitysizeItem quantity
multipliersizeUsed to calculate quantities for case packs
total_unitssizeTotal order unit quantity
namesizeSize name
code_or_namesizeSize Code or Name (if no code)
upcsizeUPC
style_number_size_namesizeConcatenation of style number and size
style_number_color_code_size_namesizeConcatenation of style number, color code, and size