...
Name | Description | Type | Example | Comment |
---|---|---|---|---|
order_line_number | The line number 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 | 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_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 | |
pack_unit | Name of pack unit in which the order quantity is expressed. | String | BOX | |
pack_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 (excluding tax). | Decimal | 19.45 |
Sample request
Code Block | ||
---|---|---|
| ||
<html> <body onload='document.forms["form"].submit()'> <form name='form' action='https://supplier.com.au/api_upload' method='post'> <input type='hidden' name='username' value='ABC123'> <input type='hidden' name='password' value='Password1'> <input type='hidden' name='format' value='Readysell'> <input type='hidden' name='account_number' value='ABC123'> <input type='hidden' name='po_number' value='12345'> <input type='hidden' name='po_date' value='2015-08-15'> <input type='hidden' name='requested_delivery_date' value='2015-08-21'> <input type='hidden' name='contact_name' value='John Smith'> <input type='hidden' name='contact_phone' value='0298765432'> <input type='hidden' name='contact_email' value='john.smith@customer.com.au'> <input type='hidden' name='allow_back_order' value='Y'> <input type='hidden' name='data' value='order_line_number,supplier_product_id,inner_barcode,customer_product_id,product_name,qty,pack_unit,pack_quantity,unit_price 1234567,TESTPROD1,,,7007123,THIS IS A TEST PRODUCT,10,BOX,10,12.95 1234568,TESTPROD2,12345678905,7007124,THIS IS ANOTHER TEST PRODUCT,20,EACH,1,3.75 1234569,TESTPROD3,12345678916,7007125,THIS IS A THIRD TEST PRODUCT,5,CARTON,100,40.95 1234570,TESTPROD4,TESTPROD4,7007126,THIS IS A FOURTH TEST PRODUCT,16,EACH,1,2.45 1234571,TESTPROD5,12345678927,7007127,THIS IS A FIFTH TEST PRODUCT,12,PACK,2,64.95'> </form> </body> </html> |
...