Overview
The OrderPassthrough endpoint allows you to create an order along with it’s details in the CIMcloud platform via the API
Setup
To use this endpoint, your Resource must have the following settings:
- Type: Special
- Function Name: Order Passthrough (POST only)
Required Fields
- order_number
- customer
- name
- address1
- city
- state
- zip
- country_code
- shipping_address
-
- address1
- city
- state
- zip
- country_code
-
- details
- sku
- quantity
- price
Example Payload: Create an Order
HTTP Method: POST
Endpoint: https://api.cimcloud.com/{sitename}/orderpassthrough/
Example Body:
{
"order_number": "Z100009",
"erp_order_number": "ERP789",
"order_source": "Online API Test Order",
"customer": {
"customer_no": "CUST123",
"division_no": "DIV456",
"salesperson_no": "SALE789",
"tax_schedule": "TaxSchedule2",
"terms_code": "NET30",
"update_master": true,
"fax": "123-456-7890",
"name": "John Doe",
"address1": "123 Main St",
"address2": "Apt 456",
"address3": "Floor 7",
"city": "Cityville",
"state": "CA",
"zip": "12345",
"country_code": "USA",
"credit_hold": false,
"customer_type": "Retail",
"email": "john.doe@example.com",
"ship_method": "Ground",
"telephone_ext": "123",
"telephone": "789-012-3456",
"price_level": "Standard"
},
"shipping_address": {
"code": "SHIP001",
"name": "Shipping Address",
"address1": "456 Shipping St",
"address2": "Suite 789",
"address3": "Dock 10",
"city": "Shipping City",
"state": "CA",
"zip": "54321",
"country_code": "USA",
"telephone": "987-654-3210",
"email": "shipping@example.com",
"address_type": "Shipping",
"attention": "Shipping Department"
},
"details": [
{
"sku": "SOFTOFF365",
"quantity": 2,
"price": 72.00
},
{
"sku": "MGPAINT1",
"quantity": 3,
"price": 20.00
}
],
"comments": "Test Order"
}