Skip to main content

SupplyOrder

Supply order provides access to the wholesales supply order resource. A supply order is placed with a supplier for delivery to the specified warehouse.

Example of a returned supplier order object with items included

{
"response": {
"Page": 1,
"PageCount": 1,
"RecordsSent": 55,
"RecordsFound": 55,
"SupplyOrder": [
{
"RSN": 1,
"OrderNum": "PO00006",
"SuppCode": "KBHAV",
"Status": 8,
"WarehouseDate": "0000-00-00T00:00:00.000Z",
"SUDelTerms": "",
"Collection": "",
"CreateDate": "2014-11-26T00:00:00.000Z",
"CfmDelivery": "0000-00-00T00:00:00.000Z",
"BuyerText": "",
"ShipAddress": "",
"FwderOrigin": "",
"FwdrDest": "",
"Article": "",
"QtyPerInnerBox": "",
"QtyPerExpCtn": "",
"XDock": false,
"UpdateStock": false,
"PayTerms": "",
"MarkOnExpCtn": "",
"TotalBuyCost": 0,
"ThirdCustCode": "",
"TotalOrderQty": 325,
"Comments": "",
"CustCode": "",
"BuyCurrency": "GBP",
"SellCurrency": "GBP",
"TotalSellPrice": 0,
"BuyExRate": 1,
"SellExRate": 1,
"TotalBuyOwnCurrency": 0,
"TotalSellOwnCurrency": 0,
"TotalLandCost": 0,
"DeliveryFrom": "",
"DCNumber": "",
"EstValueDate": "0000-00-00T00:00:00.000Z",
"CfmdValueDate": "0000-00-00T00:00:00.000Z",
"Comments2": "",
"RoyalTyPerCent": 0,
"RoyaltyDue": 0,
"USDExRate": 1,
"RoyaltyDueUSD": 0,
"EstValueDays": 0,
"MainStyle": "N/A",
"CUDeliveryTerms": "",
"OrderType": 1,
"SUShippedDate": "0000-00-00T00:00:00.000Z",
"InternalComment": "This new order cancelled on 27/11/2014 at 11:17:25 at computer Designer no reason\r26/11/2014 Delivery date changed from 02/12/2014 to 10/12/2014\r",
"ReqsPrinting": false,
"SuppRef": "",
"KimballTags": "",
"PolyBag": "",
"SampleDate1": "",
"SampleSize1": "",
"SampleColour1": "",
"SampleDate2": "",
"SampleSize2": "",
"SampleColour2": "",
"SampleDate3": "",
"SampleSize3": "",
"SampleColour3": "",
"OrdConfNotes": "",
"SUDeliveryDate": "2014-12-10T00:00:00.000Z",
"ETAPrinter": "0000-00-00T00:00:00.000Z",
"ETAPacking": "0000-00-00T00:00:00.000Z",
"CustPayTerms": "",
"Quality": "",
"Composition": "",
"Weight": "",
"LogoLabel": "",
"GarmentLabel": "",
"HangTag": "",
"OrigOrderNum": "",
"SplitCount": 0,
"PrinterCode": "",
"BrandName": "",
"DateToBank": "0000-00-00T00:00:00.000Z",
"SentInTrust": "",
"SUPayDate": "0000-00-00T00:00:00.000Z",
"PeriodYYMM": "",
"ccConverse": false,
"HQ_CustOrder_Ref": "",
"CUCfmdDelTerms": "",
"PrintOrder": 0,
"InvAddress": "",
"PrintOrdNotes": "",
"LandCurrency": "GBP",
"LandExRate": 0,
"InvoiceNum": "",
"InvoicedDate": "0000-00-00T00:00:00.000Z",
"ShowOnTurn": true,
"ShipAddr2": "",
"FwdOrigin2": "",
"FwdDest2": "",
"PayRcvdDays": 0,
"EstRcvdDate": "0000-00-00T00:00:00.000Z",
"ActRcvdDate": "0000-00-00T00:00:00.000Z",
"SUPayDays": 0,
"EstSUPayDate": "2014-12-10T00:00:00.000Z",
"OrigSUDelDate": "2014-12-02T00:00:00.000Z",
"Consignee": "",
"CUDelNotes": "",
"QualSizePerExpC": "",
"InProgress": true,
"OrigCUDelDate": "0000-00-00T00:00:00.000Z",
"ApprovedForShip": false,
"SUInvDate": "0000-00-00T00:00:00.000Z",
"SUInvNum": "",
"Transport": "A ",
"Season": "",
"WarehouseETAdate": "2014-12-15T00:00:00.000Z",
"CostCentre": 0,
"EstDelvryDays": 5,
"Sent_To_WH_Date": "0000-00-00T00:00:00.000Z",
"Accounts_Ref": "false",
"Intrastat_notc": "",
"Tradename": "CRK LONDON LTD",
"DeliveryCharge": 0,
"DeliveryMethod": "",
"Sent_To_Portal": "0000-00-00T00:00:00.000Z",
"Items": [
{
"id": 1,
"Order_id": 1,
"Supplier_Ref": "",
"Style": "C0000001",
"SKU": "C0000001001",
"Article": "POLO 1",
"Colour_Code": "001",
"Colour_Name": "BLACK",
"Buy_Price": 0,
"Line_Qty": 155,
"Line_Buy_Value": 0,
"Buy_Currency": "GBP",
"Land_Cost": 0,
"Line_Land_Value": 0,
"Land_Currency": "GBP",
"Sizes": [
{
"SKUSize": "C0000001001A",
"Size": "S",
"Qty": 15,
"SizeSort": 1
},
{
"SKUSize": "C0000001001B",
"Size": "M",
"Qty": 35,
"SizeSort": 2
},
{
"SKUSize": "C0000001001C",
"Size": "L",
"Qty": 40,
"SizeSort": 3
},
{
"SKUSize": "C0000001001D",
"Size": "XL",
"Qty": 35,
"SizeSort": 4
},
{
"SKUSize": "C0000001001E",
"Size": "XXL",
"Qty": 30,
"SizeSort": 5
}
]
},
{
"id": 2,
"Order_id": 1,
"Supplier_Ref": "",
"Style": "C0000002",
"SKU": "C0000002001",
"Article": "POLO 2",
"Colour_Code": "001",
"Colour_Name": "BLACK/ RED",
"Buy_Price": 0,
"Line_Qty": 170,
"Line_Buy_Value": 0,
"Buy_Currency": "GBP",
"Land_Cost": 0,
"Line_Land_Value": 0,
"Land_Currency": "GBP",
"Sizes": [
{
"SKUSize": "C0000002001A",
"Size": "S",
"Qty": 20,
"SizeSort": 1
},
{
"SKUSize": "C0000002001B",
"Size": "M",
"Qty": 40,
"SizeSort": 2
},
{
"SKUSize": "C0000002001C",
"Size": "L",
"Qty": 35,
"SizeSort": 3
},
{
"SKUSize": "C0000002001D",
"Size": "XL",
"Qty": 40,
"SizeSort": 4
},
{
"SKUSize": "C0000002001E",
"Size": "XXL",
"Qty": 35,
"SizeSort": 5
}
]
}
]
}
]
}
}

SupplyOrder Properties​

PropertyExampleDescription
Order_Type1Order is for own warehouse or Direct to third customer
Original_Order_NumPO10500Order number allocated at creation
Split_Count3How many time the order has been split (Part shipments etc)
id1unique record number
Order_NumPO00006Supplier order number and reference
SupplierCodeKBHAV Short code for the supplier
Status8Indicating the current staus of the supplier order (New, Confirmed Shipped etc)
Warehouse_Date0000-00-00T00:00:00.000Z The ETA to warehouse
Supplier_Delivery_TermsFOB ChinaHow the supplier is delivering the goods
CollectionJacketsOnly in use if 1 type of product per order
Creation_Date2014-11-26T00:00:00.000ZDate the order was created
Confirmed_Delivery_Date0000-00-00T00:00:00.000ZDelivery Date confirmed by supplier
Buyer_Address"1 High Street, London, SW15 7RT"Name and Address of buyer
Shipping_Address"1 High Street, London, SW15 7RT"Shipping Address
Forwarder_At_Origin"Sun Textile, Hung Wan 16, Wanchi, China"The shipping company in countyry of origin
Clearing_Agent"AirFreight Ltd, Gate 18, 5 Flight Str, Heathrow"Agent that will custom clear incomming goods
ArticleReversible JacketShort product description
Quantity_Per_Inner_Box12 PcsPacking Instruction
Quantity_Per_Export_Carton4 innerboxesPacking Instruction
Payment_Terms60DaysTerms agreed with supplier
Mark_On_Export_Carton"Ord No, Style Code, Quantity,"Any information required on the Box end label of the export carton
Total_Buy_Cost1587.25Total cost of order
Third_Customer_CodeAsosEnd buyer of order
Total_Order_Quantity325Total number of pieces purchased
CommentsNeckline must be plain stitchingInformation to the supplier
Customer_CodeilevCode for the buyer (normally the user of the software)
Buy_CurrencyGBPCurrency of the amount agreed to pay the supplier
Buy_Exchange_Rate1.2Exchange rate set in i.LEVEL for the order at the time of creation
Buy_Price_Own_Currency1035Purchase Value of order in user's selected own currency (often £)
Total_Landed_Cost1250Total cvalue of order in landed cost
Delivery_FromChinaCountry of dispatch of the order
USD_Exchange_Rate1.42USD exchange rate set in i.LEVEL for the order at the time of creation
Main_Style_CodeDE12345Style selected when only one style per order
Supplier_Shipped_Date0000-00-00T00:00:00.000ZThe date agreed for supplier to dispatch the order
Internal_CommentThis new order cancelled on 27/11/2014 at 11:17:25 at computer Designer no reason\r26/11/2014 Delivery date changed from 02/12/2014 to 10/12/2014\r Comments that must not go to supplier
Supplier_Own_ReferenceABC98765Suppliers own reference to the product purchased
Supplier_Delivery_Date2014-12-10T00:00:00.000ZOriginal agreed dispatch date by supplier
Brand_NameHugo BossName of brand
Landed_CurrencyGBPCurrency used for landed cost price
Landed_Exchange_Rate1Exchange rate set in i.LEVEL for the landed currency
Show_On_TurntrueN/A
Supplier_Pay_Days60 DaysPayment terms agreed with supplier
Original_Supplier_Delivery_Date2014-12-02T00:00:00.000ZOriginal date fo delivery agreed with supplier
Export_Carton_Detail3 Ply 30 X 50 X 40cmQuality and size of export Carton
In_ProgresstrueIndicates a supplier order still in negotiations
Approved_For_ShipmentfalseOrder has been approved by buyer for shipment
Supplier_Invoice_Date0000-00-00T00:00:00.000ZDate of suppliers invoice
Supplier_Invoice_NumInvoice number of supplier's invoice
TransportA - AirMode of Transport
SeasonSS18Season of garment ordered
Warehouse_ETA_Date2014-12-15T00:00:00.000ZEstimated date of arrival to warehouse
Cost_Centre0Cost center used for this order
Transit_Days5Time it takes from supplier delivers until landed in warehouse
Trade_NameCRK LONDON LTDTradename used for this order normally a brand name in a group
Items[]Array of supply order items see supplyorderitem resource
      • Sell_Currency | GBP | Currency of the selling price to third cust for this order Total_Sell_Price | 0 | Total value of the order Sell_Exchange_Rate | 1 E| xchange rate set in i.LEVEL for the order at the time of creation Sell_Value_Own_Currency | 2540 | Sales Value of order in user's selected own currency (often £) Customer_Delivery_Terms | FOB China by Vessel | Agreed delivery terms with end customer Confirmation_Notes | Goods will be delivered to Pack Ltd as agreed | Notes for third customer re delivery of the order Customer_Pay_Terms | 30 Days | Payment terms agreed with third party customer Confirmed_Delivery_Terms | | Terms of delivery for third party customer (Direct Orders) Invoice_Address | "1 High Street, London, SW15 7RT" | Address of the third party customer Invoice_Num | 10520 N| umber allocated ot the invoice for this order Invoiced_Date | 0000-00-00T00:00:00.000Z | Creation date of invoice Ship_Address_2 | "1 High Street, London, SW15 7RT" | Shipping Address on Order confirmation for third customer Forward_Origin_2 | "Sun Textile, Hung Wan 16, Wanchi, China" | Clearing agent Address on Order confirmation for third customer Forward_Destination_2 | "AirFreight Ltd, Gate 18, 5 Flight Str, Heathrow" | Shipping Address on Order confirmation for third customer Customer_Delivery_Notes | As agreed by Peter Jones | Notes for third customer packing list Original_Customer_Delivery_Date | 0000-00-00T00:00:00.000Z | Original delivery date agreed with third customer Intrastat_Code | 10 | Intrastat code for delivery and type Delivery_Charge | 250 | Cost of delivery to third customer Delivery_Method | By Truck | Mode of delivery
      • Sent_To_Portal 0000-00-00T00:00:00.000Z Date order was sent to production portal

SupplyOrder Methods​

GET /api/supplyorder​

Returns all supplier orders in the system with all published fields.

ShowZeros Custom Parameter​

The ShowZeros parameter can be used to display sizes for the order item that have a zero quantity in them. By default the behaviour is to return only sizes that have a non zero quantity.

Example /api/supplyorderitem?showzeros=true