Introduction
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 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 performed 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
Header fields
Name | Description | Type | Example |
|---|---|---|---|
| type | Always "Invoice" | 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 | 12345 |
| invoice_number | The invoice number as generated by the supplier's system. | String | 200001 |
| invoice_date | The date of the invoice in the supplier's system. | ISO 8601 date | 2015-08-15 |
| delivery_date | The date on which the order is expected to be delivered. | ISO 8601 date | 2015-08-21 |
Line data
Name | Description | Type | Example | Comment |
|---|---|---|---|---|
| order_line_number | The line number from the original order from the customer's system. | Integer | 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 | |
| inner_barcode | The inner barcode the product. | String | 01234567890128 | |
| product_name | The name/description of the product. | String | A4 PAPER WHITE 100GSM | |
| 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
D,type,account_number,po_number,invoice_number,invoice_date,delivery_date, H,Invoice,ABC123,12345,200001,2015-08-15,2015-08-21, D,order_line_number,supplier_product_id,inner_barcode,product_name,qty,unit_quantity,unit_price L,1234567,TESTPROD1,12345678938,THIS IS A TEST PRODUCT,10,8,12.95 L,1234568,TESTPROD2,12345678905,THIS IS ANOTHER TEST PRODUCT,20,1,3.95 L,1234569,TESTPROD3,12345678916,THIS IS A THIRD TEST PRODUCT,5,100,39.95 L,1234570,TESTPROD4,12345678949,THIS IS A FOURTH TEST PRODUCT,16,1,2.45 L,1234571,TESTPROD5,12345678927,THIS IS A FIFTH TEST PRODUCT,12,2,64.95