The call is used for sending orders to CloudSuite to update the order history of the customer. This can be, for example, an order that has been placed in the past or through another channel.
The order is only inserted in the database and no processing is done.

URL

https://test.cloudsuite.io/proxy/oci_xml/purchase

Method

POST

Parameters

user=10&shop=1&mode=sync

Parameters are customer specific.

Mapping

Field	Mandatory	Value	Remarks

Field	Mandatory	Value	Remarks
payloadID	yes	Can be any value but preferably the Cloudsuite Order ID
timestamp	yes	YYYY-MM-DD	Example: `"2018-11-12T10:30:00.757Z"`

OrderRequestHeader

Field	Mandatory	Value	Remarks

Field	Mandatory	Value	Remarks
type	yes	"sync"	If an update is required of the offline order still use the type=”sync” !
orderID	yes	The ERP order ID
orderDate	yes	The date of the order	YYYY-MM-DD Example: `2025-02-26T00:00:00`
requestedDeliveryDate		The requested delivery date	YYYY-MM-DD Visible as: Expected delivery date at the webshop This field will only be processed with the original order and not with updates.
shipTo - addressID	yes	The import_key of the customer OR the import key of the ship to address of the customer	Whether the import key of the address or the customer is required depends on the settings in Cloudsuite. Please check with Cloudsuite first. By default the import key of the billto customer is expected. When the address import key is used this setting needs to be adjusted by Cloudsuite. The address can be created. If the key is not present in CloudSuite the supplied address will be created.
billTo - addressID	yes	The import_key of the customer OR the import_key of the billto address of the customer	Whether the customer key or the billto address key is provided this depends on the settings in Cloudsuite. By default the import key of the billto customer is expected. When the address import key is used this setting needs to be adjusted by Cloudsuite.
extrinsic @ CloudSuiteCustomerReference		The description of the order
extrinsic @ CloudSuiteCustomerOrderNumber		The customer order number
extrinsic @ CloudSuiteUserEmail		The email of the user who actually placed the order

ItemOut

Field	Mandatory	Value	Remarks

Field	Mandatory	Value	Remarks
ItemOut \| @quantity	yes	The number of items ordered	The quantity of the actual SKU in Cloudsuite is required.
ItemOut \| @lineNumber	yes	The linenumber of the order	Each line must have a unique number.
ItemID \| supplierPartID	yes	The Cloudsuite import key of the product	It is possible to add products to the order which don’t excist in Cloudsuite
ItemDetail \| unitPrice - Money	yes	The price of the product	Can go up to 4 digits Whether 0 prices are allowed depends on the setting in Cloudsuite. By default 0 prices are not allowed. When they should be allowed it should be activated by Cloudsuite.
ItemDetail \| extrinsic @ Memo	no	Extra description info about the product or the line	Can contain information why a product was not delivered or changed.
ItemOut \| ScheduleLine	no	Quantity & RequestedDeliveryDate Example: `<ScheduleLine quantity="100" requestedDeliveryDate="2018-11-12"/>`	Gives the option to provide specific delivery dates per orderline and quantities Can be used to provide specific information on the backorders

Example

<?xml version="1.0" encoding="UTF-8"?>
<cXML version="1.2" payloadID="96" timestamp="2018-11-12T10:30:00.757Z" xml:lang="nl_NL">
   <Header>
        <From>
            <Credential domain="NetworkId">
                <Identity>AOP</Identity>
            </Credential>
        </From>
        <To>
            <Credential domain="NetworkId">
                <Identity>CloudSuite</Identity>
            </Credential>
        </To>
        <Sender>
            <Credential domain="NetworkId">
                <Identity>AOP</Identity>
            </Credential>
            <UserAgent>N/A</UserAgent>
        </Sender>
    </Header>
   <Request>
      <OrderRequest>
         <OrderRequestHeader type="sync" orderID="V8023612" orderDate="2020-09-12" requestedDeliveryDate="2020-09-21">
            <Total>
				<Money currency="EUR">100.00</Money>
			</Total>
            <ShipTo>
               <Address addressID="AAAGRG">
						<Name xml:lang="NL">Raimond Laan B.V.</Name>
						<PostalAddress>
							<DeliverTo/>
							<Street>Elzenkade 1a</Street>
							<City>Houten</City>
							<PostalCode>3992 AD</PostalCode>
							<Country isoCountryCode="NL">NL</Country>
						</PostalAddress>
				</Address>
            </ShipTo>
            <BillTo>
               <Address addressID="AAAGRG"/>
            </BillTo>
            <Comments/>
			<Extrinsic name="CloudSuiteCustomerReference">TEST-REF2</Extrinsic>
			<Extrinsic name="CloudSuiteCustomerOrderNumber">DESC-TEST2</Extrinsic>
			<Extrinsic name="CloudSuiteUserEmail">rlaan@cloudsuite.com</Extrinsic>
         </OrderRequestHeader>
         <ItemOut quantity="1000" lineNumber="1">
            <ItemID>
               <SupplierPartID>123456789</SupplierPartID>
            </ItemID>
            <ItemDetail>
               <UnitPrice>
                  <Money currency="EUR">25.00</Money>
               </UnitPrice>
               <Description xml:lang="nl-NL"/>
            </ItemDetail>
         </ItemOut>
         <ItemOut quantity="585" lineNumber="2">
            <ItemID>
               <SupplierPartID>987654321</SupplierPartID>
            </ItemID>
            <ItemDetail>
               <UnitPrice>
                  <Money currency="EUR">75.00</Money>
               </UnitPrice>
               <Description xml:lang="nl-NL">My product description</Description >
   			   <Extrinsic name="Memo">We changed something - optional!</Extrinsic>
            </ItemDetail>
         </ItemOut>
      </OrderRequest>
   </Request>
</cXML>

Order incoming - offline order - cXML

URL

Method

Parameters

Mapping

OrderRequestHeader

ItemOut

Related content