Quotation
Get Quotations
GET
https://api.zortout.com/api.aspx
Get list of quotations.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "GETQUOTATIONS" |
status | String | Status 0 - Pending 1 - Success Ex. "0,1" |
createusername | String | Created by (Username) |
toamount | Double | Maximum amount |
fromamount | Double | Minimum amount |
updatedatetimebefore | String | Updated Datetime Before ..... (yyyy-MM-dd HH:mm) |
updatedatetimeafter | String | Updated Datetime After ..... (yyyy-MM-dd HH:mm) |
createdatetimebefore | String | Created Datetime Before ..... (yyyy-MM-dd HH:mm) |
createdatetimeafter | String | Created Date After ..... (yyyy-MM-dd) |
updatedbefore | String | Updated Date Before ..... (yyyy-MM-dd) |
updatedafter | String | Updated Date After ..... (yyyy-MM-dd) |
createdbefore | String | Created Date Before ..... (yyyy-MM-dd) |
createdafter | String | Created Date After ..... (yyyy-MM-dd) |
quotationbefore | String | Quotation Date Before ..... (yyyy-MM-dd) |
quotationafter | String | Quotation Date After ..... (yyyy-MM-dd) |
version* | String | 3 |
format | String | json (Default), xml |
limit | Int | Limit per page (Max = 2000) |
page | Int | Page (Default = 1) |
keyword | String | Keyword to search |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
quotationidlist | String | List Of Quotation ID Ex. “123,124,125” |
numberlist | String | List Of Quotation Number Ex. “QT-001,QT-002,QT-003” |
Parameter | Type | Description/Example |
---|---|---|
res | Response | Response Code 200- Success |
list | Order (Array) | Quotation List (Array) |
count | Int | Total quotation number by filter |
Quotation (Array) | Type | Description/Example |
---|---|---|
id | Int | Quotation ID |
number | String | Quotation Number |
customerid | Int | Customer ID |
customername | String | Customer Name |
customeridnumber | String | Customer ID Number/Tax ID |
customeremail | String | Customer Email |
customerphone | String | Customer Phone |
customeraddress | String | Customer Address |
customerbranchname | String | Customer Branch Name |
customerbranchno | String | Customer Branch No |
reference | String | Reference |
status | String | Status (Pending, Success, Voided) |
amount | Double | Net Amount |
vatamount | Double | Vat Amount |
shippingamount | Double | Shipping Amount |
shippingvat | Int | Shipping Vat Status 0 - No Shipping Vat 1 - Have Shipping Vat |
quotationdate | Date | Quotation Date |
orderdateString | String | Quotation Date Text (yyyy-MM-dd) |
description | String | Description |
discount | String | Discount. Discount includes sellerdiscount and platformdiscount. Ex.5.00, 10% |
discountamount | Double | Total summary of quotation discount. |
vattype | Int | Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat |
saleschannel | String | Sales Channel |
list | QuotationProduct (Array) | Product List |
tag | String (Array) | Tag List (Array) |
createdatetime | DateTime | Created Datetime |
createdatetimeString | String | Created Datetime Text (yyyy-MM-dd HH:mm) |
updatedatetime | DateTime | Updated Datetime |
updatedatetimeString | String | Updated Datetime Text (yyyy-MM-dd HH:mm) |
approvedate | Date | Approved Date |
approvedateString | String | Approved Date Text (yyyy-MM-dd) |
expiredate | Date | Expired Date |
expiredateString | String | Expired Date Text (yyyy-MM-dd) |
createuserid | Int | Created User ID |
createusername | String | Created User (Username) |
createdby | String | Created User (Display name) |
uniquenumber | String | Unique Number |
Quotation Product (Array) | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
name | String | Product Name |
number | Double | Product Quantity |
unittext | String | Unit |
pricepernumber | Double | Product Price/Quantity |
discount | String | Discount Per Unit |
discountamount | Double | Total discount of product line. |
totalprice | Double | Total Price |
bundleid | Int (Nullable) | Bundle ID |
bundleitemid | Int (Nullable) | ID of bundle group in product line. |
Get Quotation Detail
GET
https://api.zortout.com/api.aspx
Get quotation detail.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | “GETQUOTATIONDETAIL” |
id | Int | Quotation ID *Must have either id or number |
version* | String | 3 |
format | String | json (Default), xml |
number | String | Quotation Number Require if id = 0 or null *Must have either id or number |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
id | Int | Quotation ID |
number | String | Quotation Number |
customerid | Int | Customer ID |
customername | String | Customer Name |
customeridnumber | String | Customer ID Number/Tax ID |
customeremail | String | Customer Email |
customerphone | String | Customer Phone |
customeraddress | String | Customer Address |
customerbranchname | String | Customer Branch Name |
customerbranchno | String | Customer Branch No |
reference | String | Reference |
status | String | Status (Pending, Success, Voided) |
amount | Double | Net Amount |
vatamount | Double | Vat Amount |
shippingamount | Double | Shipping Amount |
shippingvat | Int | Shipping Vat Status 0 - No Shipping Vat 1 - Have Shipping Vat |
quotationdate | Date | Quotation Date |
quotationdateString | String | Quotation Date Text (yyyy-MM-dd) |
description | String | Description |
discount | String | Discount. Discount includes sellerdiscount and platformdiscount. Ex.5.00, 10% |
discountamount | Double | Total summary of quotation discount. |
vattype | Int | Vat Type 1 – No Vat (Default) 2 – Exclude Vat 3 – Include Vat |
saleschannel | String | Sales Channel |
list | QuotationProduct (Array) | Product List |
tag | String (Array) | Tag List (Array) |
createdatetime | Datetime | Created Datetime |
createdatetimeString | String | Created Datetime Text (yyyy-MM-dd HH:mm) |
updatedatetime | Datetime | Updated Datetime |
updatedatetimeString | String | Updated Datetime Text (yyyy-MM-dd HH:mm) |
approvedate | Date | Approved Date |
approvedateString | String | Approved Date Text (yyyy-MM-dd) |
expiredate | Date | Expired Date |
expiredateString | String | Expired Date Text (yyyy-MM-dd) |
createuserid | Int | Created User ID |
createusername | String | Created User (Username) |
createdby | String | Created User (Display name) |
uniquenumber | String | Unique Number |
QuotationProduct (Array) | Type | Description/Example |
---|---|---|
productid | Int | Product ID |
sku | String | Product Sku |
name | String | Product Name |
number | Double | Product Quantity |
unittext | String | Unit |
pricepernumber | Double | Product Price/Quantity |
discount | String | Discount Per Unit |
discountamount | Double | Total discount of product line. |
totalprice | Double | Total Price |
bundleid | Int (Nullable) | Bundle ID |
bundleitemid | Int (Nullable) | ID of bundle group in product line. |
Add Quotation
POST
https://api.zortout.com/api.aspx
Add quotation.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "ADDQUOTATION" |
uniquenumber | String | Unique Number. This value is unique and used to prevent duplicate transaction. |
version* | String | 3 |
format | String | json (Default), xml |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Request Body
Name | Type | Description |
---|---|---|
number* | String | Quotation Number |
status | String | Status (Pending,Success) Default - Pending |
reference | String | Reference |
customerbranchno | String | Customer Branch No |
customerbranchname | String | Customer Branch Name |
customeraddress | String | Customer Address |
customerphone | String | Customer Phone |
customeremail | String | Customer Email |
customeridnumber | String | Customer ID Number/Tax ID |
customername | String | Customer Name |
saleschannel | String | Sales Channel |
discount | String | Discount Ex. 5.00, 10% |
description | String | Description |
quotationdate | Date | Quotation Date Ex. "2021-09-15" |
shippingvat | Int | Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat |
shippingamount | Double | Shipping Amount |
vattype | Int | Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically. |
vatamount | Double | Vat Amount |
amount* | Double | Net Amount |
∟ sku* | String | Product Sku |
list | QuotationProduct (Array) | Product List |
∟ totalprice* | Double | Total Price |
∟ discount | String | Discount Per Unit |
∟ pricepernumber* | Double | Product Price/Quantity |
∟ number* | Double | Product Quantity |
∟ name* | String | Product Name |
tag | String (Array) | Tag List (Array) |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Approve Quotation
POST
https://api.zortout.com/api.aspx
Approve quotation.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "APPROVEQUOTATION" |
approvedate | String | Approve Date (yyyy-MM-dd) |
number | String | Quotation Number Require if id = 0 or null *Must have either id or number |
id | Int | Quotation ID *Must have either id or number |
version* | String | 3 |
format | String | json (Default), xml |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apikey* | String | API Key |
apisecret* | String | API Secret |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Edit Quotation Info
POST
https://api.zortout.com/api.aspx
Edit quotation info.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "EDITQUOTATIONINFO" |
number | String | Quotation Number Require if id = 0 or null *Must have either id or number |
id | Int | Quotation ID *Must have either id or number |
version* | String | 3 |
format | String | json (Default), xml |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apisecret* | String | API Secret |
apikey* | String | API Key |
Request Body
Name | Type | Description |
---|---|---|
number | String | Quotation Number |
saleschannel | String | Sales Channel |
description | String | Description |
quotationdate | String | Quotation Date Ex. "2021-09-15" |
reference | String | Reference |
customerbranchno | String | Customer Branch No |
customerbranchname | String | Customer Branch Name |
customeraddress | String | Customer Address |
customerphone | String | Customer Phone |
customeridnumber | String | Customer ID Number/Tax ID |
customername | String | Customer Name |
customeremail | String | Customer Email |
tag | String (Array) | Tag List (Array) |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Edit Quotation
POST
https://api.zortout.com/api.aspx
Edit quotation.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "EDITQUOTATION" |
number | String | Quotation Number Require if id = 0 or null *Must have either id or number |
id | Int | Quotation ID *Must have either id or number |
version* | String | 3 |
format | String | json (Default), xml |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apisecret* | String | API Secret |
apikey* | String | API Key |
Request Body
Name | Type | Description |
---|---|---|
number | String | Quotation Number |
quotationdate | String | Quotation Date Ex. "2021-09-15" |
reference | String | Reference |
customerbranchno | String | Customer Branch No |
customerbranchname | String | Customer Branch Name |
customeraddress | String | Customer Address |
customerphone | String | Customer Phone |
customeremail | String | Customer Email |
customeridnumber | String | Customer ID Number/Tax ID |
customername | String | Customer Name |
vattype | Int | Vat Type 1 – No Vat 2 – Exclude Vat 3 – Include Vat If vattype is not defined, the system will use vatamount to calculate and define automatically. If vattype = 1, 2 or 3, the system will ignore vatamount and calculate vatamount value automatically. |
vatamount | Double | Vat Amount |
amount* | Double | Net Amount |
tag | String (Array) | Tag List (Array) |
saleschannel | String | Sales Channel |
description | String | Description |
∟ discount | String | Discount Per Unit |
∟ pricepernumber* | Double | Product Price/Quantity |
∟ number* | Double | Product Quantity |
∟ name* | String | Product Name |
∟ sku* | String | Product Sku |
list | QuotationProduct (Array) | Product List |
discount | String | Discount Ex. 5.00, 10% |
shippingvat | Int | Shipping Vat Status 0 - No Shipping Vat (Default) 1 – Have Shipping Vat |
shippingamount | Double | Shipping Amount |
∟ totalprice* | Double | Total Price |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Void Quotation
POST
https://api.zortout.com/api.aspx
Void quotation.
Query Parameters
Name | Type | Description |
---|---|---|
method* | String | "VOIDQUOTATION" |
number | String | Quotation Number Require if id = 0 or null *Must have either id or number |
id | Int | Quotation ID *Must have either id or number |
version* | String | 3 |
format | String | json (Default), xml |
Headers
Name | Type | Description |
---|---|---|
storename* | String | Store Name |
apisecret* | String | API Secret |
apikey* | String | API Key |
Parameter | Type | Description/Example |
---|---|---|
resCode | String | Response Code 200- Success |
resDesc | String | Response Description |
Last updated