2. API get order

1. List of transactions or details of a transaction via id on Ant CRM URL:

/opportunities

Method: GET

Content-Type: application/json

Parameters	Type	Cat ch set c	Explain
number	string		Id of opportunity
page	number		Page number, maximum 20 transactions per page
limit	number		Number of records per page

Results returned:

Parameters	Type	Required	Explain
name	string	AND	Trading name
receiverName	string	AND	Customer name
opportunityIdApiRing	string		Code orders
dealByUsers	array		Officer in charge. For example: [“[e-mail]”]
dealWith receiverPhone	Object string		{ “customerId”: “123”, “name”: “thong”, “phones”: [{type: “Work”, value: “023232”}], “customerIdApiRing”: “Customer Id” } Customer phone number

HTTP Response Code: 200

Response:

[{ cusFields: [

{ name: "Shipping unit", value: “Fast delivery”

}

],

description: "", groupPackage: [], name: "test", number: 3609, receiverAddressObj: {street: "", streetName: "", city: "", state: "", wards: "", cityCode: "", stateCode:

""}, receiverName: "Tuyen Do ", receiverPhone: "0123444534", stage: "", value: 4520000,

branch: “ // branch or store name, createdAt: “”, // Order creation time updatedAt: “” // Order update time

}]

1. Add transaction

URL: /opportunities

Method: POST

Content-Type: application/json

receiverAddressObj	object		Customer address. For example: { city: "Ho Chi Minh City", state: "Tan Binh district", street: "3", //(apartment number) streetName: "Nguyen Kiem", wards: "Ward 12", "country": { "code": "VN", "name": "Vietnam" } } Record the same as the address on the system.
groupPackage	array		Information line. For example: [ { name: "Beef combo", // product name quantity: 1, // quantity typeDiscount: 1, (0: cash, 1: percent) // type of discount discount: 10, // discount amount or % discount value: 1000, // Product price productIdApiRing: “1”, // product id note: "Grilled beef" // Note, code: “Sku” // Product code } ] Note: - The combo name and product in the combo must match the corresponding combo and product name
value	number		Value of the transaction. If there is no value, the system will calculate the value of the transaction according to the price on the system.
receiverNote	string		Delivery notes
description	string		Transaction description
stage	string		Transaction status
branch	string		Store or branch name
cusFields	array		AntCRM custom fields. [ { name: "Shipping unit", value: “Fast delivery” } ]

Results returned:

createdAt	Number		Creation time Type: Timestamp
shipping_cost	Number		Shipping Fee

HTTP Response Code: 200

Response:

{

"success": 1,

"number”: 9457 (id of transaction on antcrm) }

1. Edit transaction

URL: /opportunities

Method: PUT

Content-Type: application/json

Parameters	Type	Required	Explain
number	string	AND	id on crm
name	string		Trading name
receiverName	string		Customer name
receiverPhone	string		Customer phone number

receiverAddress Obj groupPackage	object array		Customer address. For example: { city: "Ho Chi Minh City", state: "Tan Binh district", street: "3", //(apartment number) streetName: "Nguyen Kiem", wards: "Ward 12", "country": { "code": "VN", "name": "Vietnam" } } Record the same as the address on the system. Information line. For example: [ { name: "Beef combo", // product name quantity: 1, // quantity typeDiscount: 1, (0: cash, 1: percent) // type of discount discount: 10, // discount amount or % discount value: 1000, // Product price productIdApiRing: “1”, // product id note: "Grilled beef" // Note, code: “Sku” // Product code } ] Note: - The combo name and product in the combo must match the corresponding combo and product name on the system.
value	number		Value of the transaction. If there is no value, the system will calculate the value of the transaction according to the price on the system.
receiverNote	string		Delivery notes
description	string		Transaction description
stage	string		Transaction status
branch	string		Store or branch name
cusFields	array		Custom fields on AntCRM. [ {
			name: "Shipping unit", value: “Fast delivery” } ]
shipping_cost	Number		Shipping fee

Results returned:

HTTP Response Code: 200

Response:

{

"success": 1,

"number”: 9457 (id of transaction on antcrm) }

1. Delete transaction

URL: /opportunities

Method: DELETE

Content-Type: application/json

Parameters	Type	Cat ch set c	Explain
number	string	A N D	id of the transaction on antcrm

Results returned: HTTP Response Code: 200

Response:

{

"success": 1 }

1. Add bulk transactions URL: /opportunities/package

Method: POST

Content-Type: application/json

Limit 100 orders per request

Body: [{order data A}, {order data B}]

Parameters	Type	Required	Explain

name	string	AND	Trading name
receiverName	string	AND	Customer name
opportunityIdApiRing	string		Code orders
dealByUsers	array		Officer in charge. For example: [“[e-mail]”]
dealWith receiverPhone	Object string		{ “customerId”: “123”, “name”: “thong”, “phones”: [{type: “Work”, value: “023232”}], “customerIdApiRing”: “Customer Id” } Customer phone number
receiverAddressObj	object		Customer address. For example: { city: "Ho Chi Minh City", state: "Tan Binh district", street: "3", //(apartment number) streetName: "Nguyen Kiem", wards: "Ward 12", "country": { "code": "VN", "name": "Vietnam" } } Record the same as the address on the system.
groupPackage	array		Information line. For example: [ {name: "Beef combo", // product name quantity: 1, // quantity typeDiscount: 1, (0: cash, 1: percent) // type of discount discount: 10, // discount amount or % discount value: 1000, // Product price productIdApiRing: “1”, // product id note: "Grilled beef" // Note, code: “Sku” // Product code } ] Note: - The combo name and product in the combo must match the corresponding combo and product name on the system. Value of the transaction. If there is no value, the system will calculate the value of the transaction according to the price on the system.
value	number		The transaction value. If no value is provided, the system will calculate the transaction value based on the system's pricing
receiverNote	number		Delivery notes
description	string		Transaction description
stage	string		Transaction status
branch	string		Store or branch name
cusFields	array		Custom fields on AntCRM. [ { name: "Shipping unit", value: “Fast delivery” } ]
createdAt	Number		Creation time Type: Timestamp
shipping_cost	Number		Shipping fee

Results returned: HTTP Response Code: 200

Response:

{

"success": 1,

"number”: [9457, 9458, 9459] (antcrm transaction id) }

1. Edit transaction URL: /opportunities/package

Method: PUT

Content-Type: application/json Limit 100 orders per request

Body: [{order data A}, {order data B}]

Parameters	Type	Required	Explain
number	string	AND	id on crm
name	string		Trading name
receiverName	string		Customer name
receiverPhone	string		Customer phone number
receiverAddress Obj groupPackage	object array		Customer address. For example: { city: "Ho Chi Minh City", state: "Tan Binh district", street: "3", //(apartment number) streetName: "Nguyen Kiem", wards: "Ward 12", "country": { "code": "VN", "name": "Vietnam" } } Record the same as the address on the system. Information line. For example: [ { name: "Beef combo", // product name quantity: 1, // quantity typeDiscount: 1, (0: cash, 1: percent) // type of discount discount: 10, // discount amount or % discount value: 1000, // Product price productIdApiRing: “1”, // product id note: "Grilled beef" // Note,
			code: “Sku” // Product code } ] Note: - The combo name and product in the combo must match the corresponding combo and product name on the system.
value	number		Value of the transaction. If there is no value, the system will calculate the value of the transaction according to the price on the system.
receiverNote	string		Delivery notes
description	string		Transaction description
stage	string		Transaction status
branch	string		Store or branch name
cusFields	array		AntCRM custom fields. [ { name: "Shipping unit", value: “Fast delivery” } ]
shipping_cost	Number		Shipping Fee

Results returned:

HTTP Response Code: 200

Response:

{

"success": 1,

"number”: [9457, 9458] (antcrm transaction id) }