GET v1/SalesOrders/{id}
Get a Sales Order.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
SalesOrderName | Description | Type | Additional information |
---|---|---|---|
InvoiceDate |
Invoice date |
date |
None. |
InvoiceNumber |
Invoice number. This is a read-only field. It is updated when an invoice date is provided. |
integer |
None. |
DispatchedDate |
The date that the order was fully dispatched. |
date |
None. |
LogisticsCarrier |
Logistics Carrier |
string |
None. |
LogisticsStatus |
Logistics Status |
integer |
None. |
EdiStatus |
Edi Status |
integer |
None. |
DistributionBranchId |
Distribution Branch |
integer |
None. |
DepartmentNumber |
Department Number |
string |
None. |
StoreLocationNumber |
Store Location Number |
string |
None. |
DistributionCenter |
Distribution Center |
string |
None. |
LineItems |
Line Items |
Collection of SalesOrderItem |
None. |
IsVoid |
Set to true to void an order; note this behaviour is irreversible. |
boolean |
None. |
AccountingAttributes |
This is for the Accounting Integration |
AccountingAttributes |
None. |
Status |
Status - (Read-only) |
OrderStatus |
None. |
Stage |
Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New) |
string |
None. |
MemberEmail |
The CRM contact email of a customer in an order |
string |
Max length: 250 |
MemberCostCenter |
Member Cost Center (Alternative GL Account). |
string |
None. |
MemberAlternativeTaxRate |
The member Alternative Tax Rate. |
string |
None. |
CostCenter |
Cost Center (Alternative GL Account). |
string |
None. |
AlternativeTaxRate |
Alternative Tax Rate. |
string |
None. |
EstimatedDeliveryDate |
Estimated Delivery Date |
date |
None. |
SalesPersonId |
The unique Cin7 user Id of the sales person. |
integer |
None. |
SalesPersonEmail |
Made obsolete. This value will be null in the response. |
string |
Max length: 250 |
PaymentTerms |
Payment terms |
string |
None. |
CustomerOrderNo |
Customer purchase order reference |
string |
None. |
VoucherCode |
Voucher code |
string |
Max length: 30 |
DeliveryInstructions |
Delivery instructions e.g. Leave at the door, beware the dog. |
string |
Max length: 2000 |
CancellationDate |
Order cancellation date - (Read-only) |
date |
None. |
ModifiedCOGSDate |
Last modified date of Cost of Good Sold(COGS) - (Read-only) |
date |
None. |
Id |
The unique Cin7 Id. |
integer |
None. |
CreatedDate |
Created date. |
date |
None. |
ModifiedDate |
Last modified date. |
date |
None. |
CreatedBy |
The ID for the User who created the Transaction. |
integer |
None. |
ProcessedBy |
The ID for the User who processed the Transaction. |
integer |
None. |
IsApproved |
Is Approved (default: true) |
boolean |
None. |
Reference |
A unique order reference (leave blank to auto-generate in an insert). |
string |
Max length: 30 |
MemberId |
The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order. |
integer |
None. |
FirstName |
Contact first name |
string |
Max length: 250 |
LastName |
Contact last name |
string |
Max length: 250 |
Company |
Contact company |
string |
Max length: 250 |
Contact email address, could be different from MemberEmail assigned to the order |
string |
Max length: 250 |
|
Phone |
Contact phone |
string |
Max length: 50 |
Mobile |
Contact mobile |
string |
Max length: 50 |
Fax |
Contact fax |
string |
Max length: 50 |
DeliveryFirstName |
Delivery recipient first name |
string |
Max length: 250 |
DeliveryLastName |
Delivery recipient last name |
string |
Max length: 250 |
DeliveryCompany |
Delivery recipient company name |
string |
Max length: 250 |
DeliveryAddress1 |
Delivery address 1 |
string |
Max length: 250 |
DeliveryAddress2 |
Delivery address 2 |
string |
Max length: 250 |
DeliveryCity |
Delivery address city |
string |
Max length: 250 |
DeliveryState |
Delivery address state |
string |
Max length: 250 |
DeliveryPostalCode |
Delivery address postcode |
string |
Max length: 250 |
DeliveryCountry |
Delivery address country |
string |
Max length: 250 |
BillingFirstName |
Billing recipient first name |
string |
Max length: 250 |
BillingLastName |
Billing recipient last name |
string |
Max length: 250 |
BillingCompany |
The billing company name |
string |
Max length: 250 |
BillingAddress1 |
Billing address 1 |
string |
Max length: 250 |
BillingAddress2 |
Billing address 2 |
string |
Max length: 250 |
BillingCity |
Billing address city |
string |
Max length: 250 |
BillingPostalCode |
Billing address postcode |
string |
Max length: 250 |
BillingState |
Billing address state |
string |
Max length: 250 |
BillingCountry |
Billing address country |
string |
Max length: 250 |
BranchId |
Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to "Main Branch" ID when omitted. |
integer |
None. |
BranchEmail |
Branch email |
string |
Max length: 250 |
ProjectName |
Project Name |
string |
None. |
TrackingCode |
Shipping tracking code |
string |
Max length: 50 |
InternalComments |
Internal comment |
string |
None. |
ProductTotal |
Product Total Only |
decimal number |
None. |
FreightTotal |
Total cost of delivery charges |
decimal number |
None. |
FreightDescription |
Freight/carrier description |
string |
None. |
Surcharge |
Surcharge |
decimal number |
None. |
SurchargeDescription |
Surcharge description |
string |
None. |
DiscountTotal |
Total overall discount |
decimal number |
None. |
DiscountDescription |
The discount description |
string |
None. |
Total |
Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax |
decimal number |
None. |
CurrencyCode |
The three-character ISO currency code e.g. NZD. Omit to use account default. |
string |
None. |
CurrencyRate |
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. |
decimal number |
None. |
CurrencySymbol |
The currency symbol e.g. $. This field is automatically populate based on currency code. |
string |
None. |
TaxStatus |
Tax Status: Incl, Excl, Exempt. Omit to use account default. |
TaxStatus |
None. |
TaxRate |
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. |
decimal number |
Range: inclusive between 0 and 100 |
Source |
The source of the Transaction. This field is read-only. |
string |
None. |
CustomFields |
Custom fields. |
Dictionary of string [key] and Object [value] |
None. |
Response Formats
application/json, text/json
{ "id": 128, "createdDate": "2024-11-16T13:41:56.1794562Z", "modifiedDate": "2024-11-16T13:41:56.1794562Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "SALE4-28", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "invoiceDate": "2024-11-16T13:41:56.1794562Z", "invoiceNumber": 0, "dispatchedDate": "2024-11-16T13:41:56.1794562Z", "logisticsCarrier": null, "logisticsStatus": null, "ediStatus": null, "distributionBranchId": null, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "lineItems": [ { "id": 1, "createdDate": "2024-11-16T13:41:56.1794562Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "uomPrice": null, "discount": 0.0, "uomQtyOrdered": null, "uomQtyShipped": 0.0, "uomSize": null, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null }, { "id": 2, "createdDate": "2024-11-16T13:41:56.1794562Z", "transactionId": 128, "parentId": 0, "productId": 2, "productOptionId": 3, "integrationRef": "LineItem2", "sort": 2, "code": "", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": 12.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 83.33, "uomPrice": 1000.0, "discount": 10.0, "uomQtyOrdered": 1.0, "uomQtyShipped": 0.0, "uomSize": 12.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null } ] }