ORDER CREATE

Use this call to add one or multiple products to the product catalog in EffectConnect.

Header information

Endpoint /orders
Method POST
Base node order
XSD order_create.xsd

 

 

Payload

Field Obligatory Type Description
number yes string (1-32) Order number. This will be for future reference.
currency yes string (3) Currency code (ISO 4217 standard)
status yes OrderStatusType Orderstatus
date yes date Order date, formatted in ISO8601 (Y-m-d\TH:i:sP)
shippingCost no decimal Shipping costs
handlingCost no decimal Handling costs
billingAddress yes orderAddress Billing address
deliveryAddress yes orderAddress Shipping address
orderLines yes collection of orderLine Order lines

 

Request example
<?xml version="1.0" encoding="utf-8"?> <order> <number>order_number_123</number> <currency>EUR</currency> <status>new</status> <date>2018-03-23T14:17:58+01:00</date> <shippingCost>4.50</shippingCost> <handlingCost>11.25</handlingCost> <billingAddress> <salutation>m</salutation> <firstName>Firstname</firstName> <lastName>Lastname</lastName> <company/> <street>Streetname</street> <houseNumber>12</houseNumber> <houseNumberExtension>a</houseNumberExtension> <addressNote>A little note</addressNote> <zipCode>1234AB</zipCode> <city>NotARealCity</city> <state>NotARealState</state> <country>NL</country> <phone>0123456789</phone> <email>notanemail@fake.com</email> </billingAddress> <shippingAddress> <salutation>m</salutation> <firstName>Firstname</firstName> <lastName>Lastname</lastName> <company/> <street>Streetname</street> <houseNumber>12</houseNumber> <houseNumberExtension>a</houseNumberExtension> <addressNote>A little note</addressNote> <zipCode>1234AB</zipCode> <city>NotARealCity</city> <state>NotARealState</state> <country>NL</country> <phone>0123456789</phone> <email>notanemail@fake.com</email> </shippingAddress> <orderLines> <orderLine> <id>order_number_123_1</id> <optionId>12345</optionId> <amount>2</amount> <price>12.50</price> <transactionFee>0</transactionFee> <sku>TEST_PROD_1</sku> <ean>1234567890123</ean> </orderLine> <orderLine> <id>order_number_123_2</id> <optionId>54321</optionId> <amount>1</amount> <price>18.00</price> <transactionFee>0</transactionFee> <sku>TEST_PROD_2</sku> <ean>1234567890124</ean> </orderLine> <orderLine> <id>order_number_123_3</id> <optionId>12121</optionId> <amount>5</amount> <price>7.50</price> <transactionFee>0</transactionFee> <sku>TEST_PROD_3</sku> <ean>1234567890125</ean> </orderLine> </orderLines> </order>
Response example
{ "Request": { "RequestType": "Order", "RequestAction": "Create", "RequestIdentifier": false, "ProcessedAt": "2018-03-23T14:17:58+01:00" }, "Response": { "Result": "Success", "OrderCreateResponseContainer": { "ID": "order_number_123" } } }
<?xml version="1.0"?> <ApiResponseContainer> <Request> <RequestType>Order</RequestType> <RequestAction>Create</RequestAction> <RequestIdentifier/> <ProcessedAt>2018-03-23T14:17:58+01:00</ProcessedAt> </Request> <Response> <Result>Success</Result> <OrderCreateResponseContainer> <ID>order_number_123</ID> </OrderCreateResponseContainer> </Response> </ApiResponseContainer>