...
CSV via HTTP is the preferred method for EDI confirmation. This method provides instant feedback to the customer on order status and does not reply on polling the supplier server, reducing network load.
Overview
The format include additional information including EZ-code, barcode and product description. We believe that it’s best to include this additional data as it can be used for validation or debugging purposes or to do manual matching to resolve data discrepancies (where required). The file is self-documenting and has 3 row types:
- D = Description (describes the purpose of the rows below)
- H = Header (header information, shown once per file)
- L = Line (line information, repeats for each line)
Transport is via an FTP server at the supplier side. Customers will upload orders to the FTP server when they are placedperformed by an HTTP(S) POST request to an endpoint URL that is unique per-customer. The endpoint will return an HTTP 200 response on success or an HTTP 500 response if there is a processing error.
Data specification
| | | |
|---|
| type | Always "OrderInvoice" | String | Order |
| account_number | The customer's account number at the supplier. | String | ABC123 |
| po_number | The purchase order number as generated by the customer's system. | Integer | 12345po |
| invoice_number | The invoice number as generated by the supplier's system. | String | 200001 |
| invoice_date | The date of the purchase order invoice in the customersupplier's system. | ISO 8601 date | 2015-08-15 |
| requested_delivery_date | The date on which the customer requests deliveryorder is expected to be delivered. | ISO 8601 date | 2015-08-21 |
| contact_name | The name of the relevant contact at the customer. | String | John Smith |
| contact_phone | The phone number of the relevant contact at the customer |
Line data
| | | | |
|---|
| | | | |
|---|
| order_line_number | The line number from the original order from the customer's system. | Integer | 0298765432 |
| contact_email | The email address of the relevant contact at the customer. | String | john.smith@customer.com.au |
| allow_back_order | Whether the customer would like to permit back orders for the selected order. | Boolean (Y/N) | Y |
Line data
| 1234567 | Unique per customer ERP system, not per customer order. |
| supplier_product_id | The product ID of the product in the supplier's system. | String | A1234 | Relies on the data in the customer's product file. May not be available, so other fields may need to be checked to assist with matching. |
| inner_barcode | The inner barcode the product. | String | 01234567890128 | Relies on the data in the customer's product file. May not be available, so other fields may need to be checked to assist with matching. |
| customer_product_id | The product ID of the product in the customer's system. | String | 7001234 | This will always be provided. Usually the Office Brands EZ Code – but could be a customer’s own code if the product is set up manually. |
| product |
| product_name | The name/description of the product. | String | A4 PAPER WHITE 100GSM | Typically used to provide helpful feedback to the customer if no match could be found. |
| qty | Unit quantity ordered. | Integer | 6 | |
| unit_quantity | Quantity of inners in each unit being ordered. | Integer | 10 | For example, if an order is being placed for 6 cartons and each carton contains 10 boxes (where a box is the sell/inner unit), this field will contain 10. |
| unit_price | The price for each unit ordered. | Decimal | 19.45 | |
Sample message
| Code Block |
|---|
|
D,type,account_number,po_number, |
poinvoice_number,invoice_date, |
requested_contact_name,contact_phone,contact_email,allow_back_orderOrderInvoice,ABC123,12345,200001,2015-08-15,2015-08-21, |
John Smith,0298765432,john.smith@customer.com.au,YD,
D,order_line_number,supplier_product_id,inner_barcode |
,customer_product_id,product_name,qty,unit_quantity,unit_price |
,,,700712312345678938,THIS IS A TEST PRODUCT,10, |
10,,,
L,1234568,TESTPROD2,12345678905 |
,7007124,THIS IS ANOTHER TEST PRODUCT,20,1,3. |
75,,,95
L,1234569,TESTPROD3,12345678916 |
,7007125,THIS IS A THIRD TEST PRODUCT,5,100, |
40,,,700712612345678949,THIS IS A FOURTH TEST PRODUCT,16,1,2.45 |
,,,
L,1234571,TESTPROD5,12345678927 |
,7007127,THIS IS A FIFTH TEST PRODUCT,12,2,64.95 |
,,,