Get a list of Sales Orders.
Request
- Base URL: https://api.cin7.com (the document declares no server; this is the origin it was published from)
- URL: https://api.cin7.com/api/v1/SalesOrders
- Auth: none declared
Query parameters
A comma-separated list of field names
A where clause
An order by clause
The page number (default: 1)
Rows per page (default: 50, maximum: 250)
Response
OK
The unique Cin7 Id.
Created date.
Last modified date.
The ID for the User who created the Transaction.
The ID for the User who processed the Transaction.
Is Approved (default: true)
A unique order reference (leave blank to auto-generate in an insert).
The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order.
Contact first name
Contact last name
Contact company
Contact email address, could be different from MemberEmail assigned to the order
Contact phone
Contact mobile
Contact fax
Delivery recipient first name
Delivery recipient last name
Delivery recipient company name
Delivery address 1
Delivery address 2
Delivery address city
Delivery address state
Delivery address postcode
Delivery address country
Billing recipient first name
Billing recipient last name
The billing company name
Billing address 1
Billing address 2
Billing address city
Billing address postcode
Billing address state
Billing address country
Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to "Main Branch" ID when omitted.
Branch email
Project Name
Shipping tracking code
Internal comment
Product Total Only
Total cost of delivery charges
Freight/carrier description
Surcharge
Surcharge description
Total overall discount
The discount description
Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax
The unique Cin7 currency Id.
The three-character ISO currency code e.g. NZD. Omit to use account default.
The currency rate. If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service.
The currency symbol e.g. $. This field is automatically populate based on currency code.
Tax Status
Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.
The source of the Transaction. This field is read-only.
Custom fields.
Order status.
Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)
The CRM contact email of a customer in an order
Member Cost Center (Alternative GL Account).
The member Alternative Tax Rate.
Cost Center (Alternative GL Account).
Alternative Tax Rate.
Estimated Delivery Date
The unique Cin7 user Id of the sales person.
Made obsolete. This value will be null in the response.
Payment terms
Customer purchase order reference
Voucher code
Delivery instructions e.g. Leave at the door, beware the dog.
Order cancellation date - (Read-only)
Last modified date of Cost of Good Sold(COGS) - (Read-only)
Invoice date
Invoice number. This is a read-only field. It is updated when an invoice date is provided.
The date that the order was fully dispatched.
Logistics Carrier
Logistics Status
Edi Status
Distribution Branch
Department Number
Store Location Number
Distribution Center
Set to true to void an order; note this behaviour is irreversible.
Changes
No recorded changes to this operation across all 1 revision of this API.