POST OrderPassThrough Request

Overview

The OrderPassThrough endpoint allows you to create an order along with its 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

Available Fields

Order Header Fields

Field Name	Type	Description
order_number	string	Order number (required)
erp_order_number	string	ERP system order number
ref_id	string	Reference ID
order_source	string	Source of the order
po_number	string	Purchase order number
carrier_code	string	Shipping carrier code
ship_method	string	Shipping method
erp_ship_via	string	ERP shipping via code
carrier_name	string	Shipping carrier name
requested_date	string	Requested delivery date
order_date	DateTime	Date order was placed
lifecycle_stage	string	Current lifecycle stage of the order
comments	string	Order comments
shipping_total	decimal	Total shipping cost
tax_total	decimal	Total tax amount
order_total	decimal	Total order amount
erp_ship_to_code	string	ERP ship-to code
erp_ship_to_tax_schedule	string	ERP ship-to tax schedule
erp_sales_tax_schedule	string	ERP sales tax schedule
erp_ship_to_warehouse	string	ERP ship-to warehouse
erp_print_sales_order	string	ERP print sales order flag
erp_print_pick_sheet	string	ERP print pick sheet flag
erp_order_type	string	ERP order type
erp_order_status	string	ERP order status
erp_hold_reason_code	string	ERP hold reason code

Customer Fields

Field Name	Type	Description
customer_no	string	Customer number
division_no	string	Division number
salesperson_no	string	Salesperson number
tax_schedule	string	Tax schedule
terms_code	string	Payment terms code
update_master	bool	Update master customer record
fax	string	Fax number
name	string	Customer name (required)
address1	string	Address line 1 (required)
address2	string	Address line 2
address3	string	Address line 3
city	string	City (required)
state	string	State (required)
zip	string	ZIP/Postal code (required)
country_code	string	Country code (required)
credit_hold	bool	Credit hold status
customer_type	string	Customer type
email	string	Email address
ship_method	string	Shipping method
telephone_ext	string	Telephone extension
telephone	string	Telephone number
price_level	string	Price level

Shipping Address Fields

Field Name	Type	Description
code	string	Address code
name	string	Recipient name
address1	string	Address line 1 (required)
address2	string	Address line 2
address3	string	Address line 3
city	string	City (required)
state	string	State (required)
zip	string	ZIP/Postal code (required)
country_code	string	Country code (required)
telephone	string	Telephone number
email	string	Email address
address_type	string	Address type
attention	string	Attention line
update_master	bool	Update master address record
ship_to_code	string	Ship-to account number
ship_to_name	string	Ship-to company name

Order Details Fields

Field Name	Type	Description
ref_id	string	Line item reference ID
quantity	int	Quantity ordered (required)
sku	string	Product SKU (required)
price	decimal	Unit price (required)
extended_price	decimal	Extended price (quantity × price)
unit_of_measure	string	Unit of measure
warehouse_code	string	Warehouse code
comment	string	Line item comment
item_type	string	Item type

Payment Fields

Field Name	Type	Description
deposit_amt	decimal	Deposit amount
payment_type	string	Payment type
ref_no	string	Payment reference number
country	string	Credit card billing country
auth_code	string	Credit card authorization code
last_4	string	Last 4 digits of credit card
trans_state	string	Transaction state

Coupon Fields

Field Name	Type	Description
amount	decimal	Coupon discount amount
user_code	string	Coupon code entered by user
item_code	string	Coupon item code

Gift Card Fields

Field Name	Type	Description
deposit_amt	decimal	Gift card deposit amount
user_code	string	Gift card code entered by user
item_code	string	Gift card item code

Tax Fields

Field Name	Type	Description
schedule	string	Tax schedule

Custom Fields

Both the order header and order details support custom fields as an array of name-value pairs:

Field Name	Type	Description
name	string	Custom field name
value	string	Custom field value

Example Payload: Create an Order

Example Body:

{
  "order_number": "Z100009",
  "erp_order_number": "ERP789",
  "order_source": "Online API Test Order",
  "lifecycle_stage": "Processing",
  "erp_ship_via": "FEDEX",
  "carrier_name": "FedEx Ground",
  "erp_ship_to_code": "SHIP001",
  "erp_ship_to_tax_schedule": "TAXSCHED1",
  "erp_sales_tax_schedule": "SALES_TAX_1",
  "erp_ship_to_warehouse": "WAREHOUSE01",
  "erp_order_type": "STANDARD",
  "erp_order_status": "OPEN",
  "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",
    "ship_to_code": "ACCT123",
    "ship_to_name": "Acme Corporation"
  },
  "payment": {
    "deposit_amt": 100.00,
    "payment_type": "CreditCard",
    "ref_no": "REF123456",
    "country": "USA",
    "auth_code": "AUTH789",
    "last_4": "1234",
    "trans_state": "Approved"
  },
  "details": [
    {
      "sku": "SOFTOFF365",
      "quantity": 2,
      "price": 72.00,
      "extended_price": 144.00,
      "warehouse_code": "WAREHOUSE01"
    },
    {
      "sku": "MGPAINT1",
      "quantity": 3,
      "price": 20.00,
      "extended_price": 60.00,
      "warehouse_code": "WAREHOUSE01"
    }
  ],
  "comments": "Test Order",
  "shipping_total": 15.00,
  "tax_total": 19.92,
  "order_total": 238.92
}