Get Customers
GET
/customersExample response body
{
"Result": {
"Table": [
{
"Customer": "CustomerCode01",
"Name": "Customer 01 Name"
},
{
"Customer": "CustomerCode02",
"Name": "Customer 02 Name"
},
{
"Customer": "CustomerCode03",
"Name": "Customer 03 Name"
}
}Get Customer Data
POST
/get-customer-data{
"operator": "OPS01",
"CustomerCode": "ACME001"
}Example response body
{
"CustomerDetails": {
"@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"CustomerDetail": {
"Customer": "ACME001",
"Name": "Acme Wildlife Supplies Ltd",
"Contact": "James Cartwright",
"Telephone": "0207 123 4567",
"AddTelephone": "",
"Email": "accounts@acmewildlife.co.uk",
"Salesperson": "450",
"Currency": "GBP",
"CompanyTaxNumber": "",
"TaxExemptNumber": "",
"CreditLimit": "7500",
"TermsCode": "30",
"Terms": "Net 30 Days",
"UserField1": "",
"UserField2": "0.00",
"Area": "GB",
"SoldToAddr1": "Acme Distribution Centre",
"SoldToAddr2": "Unit 4 Industrial Park",
"SoldToAddr3": "Birmingham",
"SoldToAddr3Loc": "",
"SoldToAddr4": "West Midlands",
"SoldToAddr5": "",
"SoldPostalCode": "B1 1AA",
"ShipToAddr1": "Acme Distribution Centre",
"ShipToAddr2": "Unit 4 Industrial Park",
"ShipToAddr3": "Birmingham",
"ShipToAddr3Loc": "",
"ShipToAddr4": "",
"ShipToAddr5": "",
"ShipPostalCode": "B1 1AA",
"Addresses": {
"AddressLineDetail": [
{
"AddressCode": "00001",
"ShipToName": "Acme Wildlife Supplies Ltd",
"ShipToAddr1": "Acme Distribution Centre",
"ShipToAddr2": "Unit 4 Industrial Park",
"ShipToAddr3": "",
"ShipToAddr3Loc": "Birmingham",
"ShipToAddr4": "West Midlands",
"ShipToAddr5": "",
"ShipPostalCode": "B1 1AA",
"Area": "GB",
"Nationality": "GB",
"ShippingLocation": "",
"Email": "warehouse@acmewildlife.co.uk",
"DefaultVan": "7VAN22",
"AddressType": "Commercial"
},
{
"AddressCode": "00002",
"ShipToName": "James Cartwright",
"ShipToAddr1": "Acme Retail Warehouse",
"ShipToAddr2": "15 Commerce Way",
"ShipToAddr3": "",
"ShipToAddr3Loc": "Leeds",
"ShipToAddr4": "West Yorkshire",
"ShipToAddr5": "GB",
"ShipPostalCode": "LS1 2AB",
"Area": "GB",
"Nationality": "GB",
"ShippingLocation": "",
"Email": "logistics@acmewildlife.co.uk",
"DefaultVan": "7VAN22",
"AddressType": "Commercial"
}
]
},
"ShippingDiscounts": {
"ShippingDiscount": [
{ "ShippingCode": "8APCJER", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCLW16", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCND10", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCND12", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCND12FROZ", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCND12SAT", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCND16", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCSCOT12", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCSCOT16", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCSCOTB16", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8APCSCOTHIGH12", "ThresholdVal": "350.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXEHIGH", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXEIOW", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXEND13", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXENDLA", "ThresholdVal": "200.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXENDLAIOW", "ThresholdVal": "200.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXESAT", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXESAT13", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "8DXESUN", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALECO2", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALECO3", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALECO4", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALECO5", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALECO6", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALND2", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALND3", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALND4", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALND5", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9PALND6", "ThresholdVal": "500.00", "DiscountPct": "100.000" },
{ "ShippingCode": "9VAN2W", "ThresholdVal": "0.00", "DiscountPct": "100.000" }
]
}
}
}
}Get Order Form Data
POST
/get-order-form-data{
"operator": "OPS01",
"Customer": "ACME001"
}Example response body
{
"CustomerDetails": {
"@xmlns:xsi": "http://www.w3.org/2001/XMLSchema-instance",
"CustomerDetail": {
"Customer": "ACME001",
"Name": "Acme Wildlife Supplies Ltd",
"Contact": "James Cartwright",
"Telephone": "0207 123 4567",
"AddTelephone": "",
"Email": "accounts@acmewildlife.co.uk",
"Salesperson": "450",
"Currency": "GBP",
"CompanyTaxNumber": "987654321",
"TaxExemptNumber": "",
"CreditLimit": "5000",
"TermsCode": "30",
"Terms": "Net 30 Days",
"UserField1": "",
"UserField2": "0.00",
"Area": "GB",
"CreditCheck": {
"CreditCheck": {
"Result": "Pass",
"HoldCheck": "Pass",
"LimitCheck": "Pass",
"TermsCheck": "Pass"
}
},
"SoldToAddr1": "Acme Distribution Centre",
"SoldToAddr2": "Unit 4 Industrial Park",
"SoldToAddr3": "Birmingham",
"SoldToAddr3Loc": "",
"SoldToAddr4": "West Midlands",
"SoldToAddr5": "",
"SoldPostalCode": "B1 1AA",
"ShipToAddr1": "Acme Retail Warehouse",
"ShipToAddr2": "15 Commerce Way",
"ShipToAddr3": "Leeds",
"ShipToAddr3Loc": "West Yorkshire",
"ShipToAddr4": "",
"ShipToAddr5": "",
"ShipPostalCode": "LS1 2AB",
"Addresses": {
"AddressLineDetail": [
{
"AddressCode": "00001",
"ShipToName": "Acme Wildlife Supplies Ltd",
"ShipToAddr1": "Acme Distribution Centre",
"ShipToAddr2": "Unit 4 Industrial Park",
"ShipToAddr3": "",
"ShipToAddr3Loc": "Birmingham",
"ShipToAddr4": "West Midlands",
"ShipToAddr5": "",
"ShipPostalCode": "B1 1AA",
"Area": "GB",
"Nationality": "GB",
"ShippingLocation": "",
"Email": "warehouse@acmewildlife.co.uk",
"DefaultVan": "7VAN22",
"AddressType": "Commercial"
},
{
"AddressCode": "00002",
"ShipToName": "Acme Wildlife Supplies Ltd",
"ShipToAddr1": "Acme Retail Warehouse",
"ShipToAddr2": "15 Commerce Way",
"ShipToAddr3": "",
"ShipToAddr3Loc": "Leeds",
"ShipToAddr4": "West Yorkshire",
"ShipToAddr5": "",
"ShipPostalCode": "LS1 2AB",
"Area": "GB",
"Nationality": "GB",
"ShippingLocation": "",
"Email": "logistics@acmewildlife.co.uk",
"DefaultVan": "7VAN22",
"AddressType": "Commercial"
}
]
},
"Products": {
"Product": [
{
"StockCode": "PROD01",
"Description": "Example Product One",
"Mass": "0.258000",
"Volume": "0.000000",
"Supplier": "RTAN",
"ProductClass": "01",
"TaxCode": "1 ",
"TaxPercent": "20.00000",
"KitType": "N",
"StockOnHold": "",
"StockOnHoldReason": "",
"SalesOnHold": "",
"ProductGroup": "YAU",
"OnHoldReason": "",
"Warehouse": "1",
"SelectionArea": "ACME001",
"DiscountPercentage": "25.000000000000000000",
"SellingPrice": "5.18000",
"DiscountAmount": "1.30000000000",
"SellingPriceLessDiscount": "3.89000000000",
"Stock": "119",
"Weight": "0.000000",
"ProductLength": "110",
"ProductWidth": "140",
"ProductHeight": "75",
"UnitBarcode": "5055312389003",
"Hazardous": "N",
"WebProduct": "Y"
},
{
"StockCode": "PROD02",
"Description": "Example Product Two",
"Mass": "0.054000",
"Volume": "0.000000",
"Supplier": "RTAN",
"ProductClass": "01",
"TaxCode": "1 ",
"TaxPercent": "20.00000",
"KitType": "N",
"StockOnHold": "",
"StockOnHoldReason": "",
"SalesOnHold": "",
"ProductGroup": "YAU",
"OnHoldReason": "",
"Warehouse": "1",
"SelectionArea": "ACME001",
"DiscountPercentage": "25.000000000000000000",
"SellingPrice": "0.59000",
"DiscountAmount": "0.15000000000",
"SellingPriceLessDiscount": "0.44000000000",
"Stock": "1783",
"Weight": "0.000000",
"ProductLength": "21",
"ProductWidth": "170",
"ProductHeight": "65",
"UnitBarcode": "6975174211467",
"Hazardous": "N",
"WebProduct": "Y"
},
{
"StockCode": "PROD03",
"Description": "Example Product Three",
"Mass": "0.094000",
"Volume": "0.000000",
"Supplier": "RTAN",
"ProductClass": "01",
"TaxCode": "1 ",
"TaxPercent": "20.00000",
"KitType": "N",
"StockOnHold": "",
"StockOnHoldReason": "",
"SalesOnHold": "",
"ProductGroup": "YAU",
"OnHoldReason": "",
"Warehouse": "1",
"SelectionArea": "ACME001",
"DiscountPercentage": "25.000000000000000000",
"SellingPrice": "0.85000",
"DiscountAmount": "0.21000000000",
"SellingPriceLessDiscount": "0.64000000000",
"Stock": "1786",
"Weight": "0.000000",
"ProductLength": "24",
"ProductWidth": "236",
"ProductHeight": "63",
"UnitBarcode": "6975174211474",
"Hazardous": "N",
"WebProduct": "Y"
}
]
}
}
}
}Get Shipping Options
POST
/get-shipping-options{
"operator": "OPS01",
"customerCode": "ACME001",
"shippingAddressCode": "00001",
"addressData": null,
"salesOrderLines": [
{
"orderLine": {
"stockCode": "HPH005",
"quantity": "1",
"unitOfMeasure": "EA"
}
},
{
"orderLine": {
"stockCode": "A0001",
"quantity": "1",
"unitOfMeasure": "EA"
}
},
{
"orderLine": {
"stockCode": "ZA20010",
"quantity": "1",
"unitOfMeasure": "EA"
}
}
],
"orderValue": 149.52
}Example response body
{
"Summary": {
"Result": {
"Table": {
"Customer": "ACME001",
"AddressCode": "00001",
"ShipToAddr1": "Acme Retail Warehouse",
"ShipToAddr2": "15 Commerce Way",
"ShipToAddr3": {
"@xml:space": "preserve",
"#significant-whitespace": " "
},
"ShipToAddr3Loc": "Leeds",
"ShipToAddr4": "West Yorkshire",
"ShipToAddr5": {
"@xml:space": "preserve",
"#significant-whitespace": " "
},
"ShipPostalCode": "LS1 2AB",
"AddressType": "Commercial",
"DefaultVan": "9VAN2W",
"TotalOrderMass": "4.11",
"MaxOrderDimension": "550.00",
"HasHazardous": "N",
"HasFrozenOrLive": "Y",
"HasAnimal": "false",
"HasFrozen": "true",
"HasLivefood": "true",
"OrderTotal": "149.52"
}
}
},
"Methods": {
"ShippingCode": [
"8ACOLL001",
"8APCND12FROZ",
"8APCND12SAT",
"8DXEND13",
"8DXESAT",
"8DXESAT13",
"8DXESUN",
"9VAN2W"
]
},
"Options": {
"Result": {
"Table": [
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-02T00:00:00+00:00",
"DeliveryDate": "2026-03-03T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-03T00:00:00+00:00",
"DeliveryDate": "2026-03-04T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-04T00:00:00+00:00",
"DeliveryDate": "2026-03-05T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-05T00:00:00+00:00",
"DeliveryDate": "2026-03-06T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-08T00:00:00+00:00",
"DeliveryDate": "2026-03-09T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-09T00:00:00+00:00",
"DeliveryDate": "2026-03-10T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-10T00:00:00+00:00",
"DeliveryDate": "2026-03-11T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-11T00:00:00+00:00",
"DeliveryDate": "2026-03-12T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-12T00:00:00+00:00",
"DeliveryDate": "2026-03-13T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8ACOLL001",
"ShippingDesc": "Collection (at Returns Unit)",
"Courier": "Collection",
"PackLocation": "COLLECTION",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "99999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "B",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT8H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-15T00:00:00+00:00",
"DeliveryDate": "2026-03-16T00:00:00+00:00",
"FullPrice": "0.00",
"DiscountAmount": "0.00",
"Price": "0.00"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-02T00:00:00+00:00",
"DeliveryDate": "2026-03-03T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-03T00:00:00+00:00",
"DeliveryDate": "2026-03-04T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-04T00:00:00+00:00",
"DeliveryDate": "2026-03-05T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-05T00:00:00+00:00",
"DeliveryDate": "2026-03-06T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-09T00:00:00+00:00",
"DeliveryDate": "2026-03-10T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-10T00:00:00+00:00",
"DeliveryDate": "2026-03-11T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-11T00:00:00+00:00",
"DeliveryDate": "2026-03-12T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12FROZ",
"ShippingDesc": "APC NextDay 12pm IncFrozen B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-12T00:00:00+00:00",
"DeliveryDate": "2026-03-13T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "13.43",
"DiscountAmount": "0.00",
"Price": "13.43"
},
{
"ShippingCode": "8APCND12SAT",
"ShippingDesc": "APC Next Day Sat 12pm 20kg B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-06T00:00:00+00:00",
"DeliveryDate": "2026-03-07T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "16.00",
"DiscountAmount": "0.00",
"Price": "16.00"
},
{
"ShippingCode": "8APCND12SAT",
"ShippingDesc": "APC Next Day Sat 12pm 20kg B2B",
"Courier": "APC",
"PackLocation": "APC",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "280.00",
"Currency": "GBP",
"Cost": "11.35",
"MaxLength": "1.20",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-13T00:00:00+00:00",
"DeliveryDate": "2026-03-14T00:00:00+00:00",
"ThresholdVal": "350.00",
"DiscountPct": "100.000",
"FullPrice": "16.00",
"DiscountAmount": "0.00",
"Price": "16.00"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-02T00:00:00+00:00",
"DeliveryDate": "2026-03-03T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-03T00:00:00+00:00",
"DeliveryDate": "2026-03-04T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-04T00:00:00+00:00",
"DeliveryDate": "2026-03-05T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-05T00:00:00+00:00",
"DeliveryDate": "2026-03-06T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT16H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-08T00:00:00+00:00",
"DeliveryDate": "2026-03-09T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Monday",
"DeliveryDay": "Tuesday",
"ShipDate": "2026-03-09T00:00:00+00:00",
"DeliveryDate": "2026-03-10T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-10T00:00:00+00:00",
"DeliveryDate": "2026-03-11T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Wednesday",
"DeliveryDay": "Thursday",
"ShipDate": "2026-03-11T00:00:00+00:00",
"DeliveryDate": "2026-03-12T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT18H30M",
"ShipDay": "Thursday",
"DeliveryDay": "Friday",
"ShipDate": "2026-03-12T00:00:00+00:00",
"DeliveryDate": "2026-03-13T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXEND13",
"ShippingDesc": "DX Express Next Day 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT16H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-15T00:00:00+00:00",
"DeliveryDate": "2026-03-16T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXESAT",
"ShippingDesc": "DX Express Sat Delivery B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "18.81",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT17H30M",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-06T00:00:00+00:00",
"DeliveryDate": "2026-03-07T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "19.70",
"DiscountAmount": "0.00",
"Price": "19.70"
},
{
"ShippingCode": "8DXESAT",
"ShippingDesc": "DX Express Sat Delivery B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "18.81",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT17H30M",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-13T00:00:00+00:00",
"DeliveryDate": "2026-03-14T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "19.70",
"DiscountAmount": "0.00",
"Price": "19.70"
},
{
"ShippingCode": "8DXESAT13",
"ShippingDesc": "DX Express Sat Deliver 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "23.66",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT17H30M",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-06T00:00:00+00:00",
"DeliveryDate": "2026-03-07T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "26.92",
"DiscountAmount": "0.00",
"Price": "26.92"
},
{
"ShippingCode": "8DXESAT13",
"ShippingDesc": "DX Express Sat Deliver 1pm B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "250.00",
"Currency": "GBP",
"Cost": "23.66",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT17H30M",
"ShipDay": "Friday",
"DeliveryDay": "Saturday",
"ShipDate": "2026-03-13T00:00:00+00:00",
"DeliveryDate": "2026-03-14T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "26.92",
"DiscountAmount": "0.00",
"Price": "26.92"
},
{
"ShippingCode": "8DXESUN",
"ShippingDesc": "DX Express ND by 1, MONDAY B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "300.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "N",
"CollectionTimeTurnaround": "PT16H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-08T00:00:00+00:00",
"DeliveryDate": "2026-03-09T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "8DXESUN",
"ShippingDesc": "DX Express ND by 1, MONDAY B2B",
"Courier": "DX",
"PackLocation": "DX",
"VanYN": "N",
"MinWeight": "0.00",
"MaxWeight": "300.00",
"Currency": "GBP",
"Cost": "16.39",
"MaxLength": "2.00",
"Residential": "N",
"Hazardous": "N",
"Consolidation": "N",
"CollectionTimeTurnaround": "PT16H",
"ShipDay": "Sunday",
"DeliveryDay": "Monday",
"ShipDate": "2026-03-15T00:00:00+00:00",
"DeliveryDate": "2026-03-16T00:00:00+00:00",
"ThresholdVal": "500.00",
"DiscountPct": "100.000",
"FullPrice": "17.16",
"DiscountAmount": "0.00",
"Price": "17.16"
},
{
"ShippingCode": "9VAN2W",
"ShippingDesc": "Peregrine Van 2 Wednesday",
"Courier": "Peregrine Van",
"PackLocation": "VAN2",
"VanYN": "Y",
"MinWeight": "0.00",
"MaxWeight": "999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "N",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H30M",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-03T00:00:00+00:00",
"DeliveryDate": "2026-03-04T00:00:00+00:00",
"ThresholdVal": "0.00",
"DiscountPct": "100.000",
"FullPrice": "10.95",
"DiscountAmount": "10.95",
"Price": "0.00"
},
{
"ShippingCode": "9VAN2W",
"ShippingDesc": "Peregrine Van 2 Wednesday",
"Courier": "Peregrine Van",
"PackLocation": "VAN2",
"VanYN": "Y",
"MinWeight": "0.00",
"MaxWeight": "999.00",
"Currency": "GBP",
"Cost": "0.00",
"MaxLength": "999.00",
"Residential": "N",
"Hazardous": "Y",
"Consolidation": "Y",
"CollectionTimeTurnaround": "PT19H30M",
"ShipDay": "Tuesday",
"DeliveryDay": "Wednesday",
"ShipDate": "2026-03-10T00:00:00+00:00",
"DeliveryDate": "2026-03-11T00:00:00+00:00",
"ThresholdVal": "0.00",
"DiscountPct": "100.000",
"FullPrice": "10.95",
"DiscountAmount": "10.95",
"Price": "0.00"
}
]
}
}
}Create Order
POST
/create-order{
"operator": "OPS01",
"id": "",
"syspro_id": "",
"account_code": "ACME001",
"po_number": "",
"currency": "GBP",
"date_created": "2026-03-02 16:13:49",
"total": 27.54,
"total_tax": 4.59,
"shipping": {
"first_name": "Acme Wildlife Supplies Ltd",
"last_name": "",
"company": "",
"address_1": "Acme Retail Warehouse",
"address_2": "15 Commerce Way",
"address_3": "",
"city": "Leeds",
"state": "West Yorkshire",
"postcode": "LS1 2AB",
"country": "GB",
"shipping_property_type": "Commercial",
"shipping_code": "8APCND12",
"address_code": "00002",
"shipping_name": "Acme Wildlife Supplies Ltd",
"shipping_fullprice": "11.36",
"shipping_discount": "0.00",
"shipping_price": "11.36",
"dispatch_date": "2026-03-03T00:00:00+00:00",
"delivery_date": "2026-03-04T00:00:00+00:00"
},
"validate_shipping": "N",
"customer_note": "",
"syspro_order_type": "P",
"website": "portal.examplecompany.co.uk",
"line_items": [
{
"id": 0,
"sku": "SMB016",
"quantity": "1",
"price": "22.95",
"discount": 0,
"subtotal": "22.95",
"subtotal_tax": "4.59",
"total": 27.54,
"total_tax": "4.59"
}
]
}Example response body
{
"?xml": {
"@version": "1.0",
"@encoding": "Windows-1252"
},
"SalesOrders": {
"@Language": "05",
"@Language2": "EN",
"@CssStyle": "",
"@DecFormat": "1",
"@DateFormat": "01",
"@Role": "01",
"@Version": "8.0.161",
"@OperatorPrimaryRole": "095",
"Order": {
"CustomerPoNumber": null,
"SalesOrder": 1999990",
"OrderActionType": "A",
"WarningMessages": {
"WarningDescription": ""
}
},
"StatusOfItems": {
"ItemsProcessed": "000001",
"ItemsRejectedWithWarnings": "000000",
"ItemsProcessedWithWarnings": "000000"
}
}
}