Quotation

Get Quotations

GET https://open-api.zortout.com/v4/Quotation/GetQuotations

Get list of quotations.

Query Parameters

Name	Type	Description
quotationafter	String	Quotation Date After ..... (yyyy-MM-dd)
page	Int	Page (Default = 1)
keyword	String	Keyword to search
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 Datetime After ..... (yyyy-MM-dd HH:mm)
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)
limit	Int	Limit per page (Max = 500)

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”

200: OK Success

Response

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
amount_pretax	Double	Pretax Amount
vatamount	Double	Vat Amount
shippingamount	Double	Shipping Amount
shippingamount_pretax	Double	Pretax Shipping Amount
shippingamount_vat	Double	Shipping Vat 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.
discountamount_pretax	Double	Total summary of pretax quotation discount.
discountamount_vat	Double	Total summary of quotation vat.
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
pricepernumber_pretax	Double	Pretax Product Price/Quantity
pricepernumber_vat	Double	Product Vat/Quantity
discount	String	Discount Per Unit
discountamount	Double	Total discount of product line.
discountamount_pretax	Double	Total pretax discount of product line.
discountamount_vat	Double	Total discount vat of product line.
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat
bundleid	Int (Nullable)	Bundle ID
bundleitemid	Int (Nullable)	ID of bundle group in product line.

Get Quotation Detail

GET https://open-api.zortout.com/v4/Quotation/GetQuotationDetail

Get quotation detail.

Query Parameters

Name	Type	Description
id	Int	Quotation ID *Must have either id or number
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

200: OK Success

Response

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
amount_pretax	Double	Pretax Amount
vatamount	Double	Vat Amount
shippingamount	Double	Shipping Amount
shippingamount_pretax	Double	Pretax Shipping Amount
shippingamount_vat	Double	Shipping Vat 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.
discountamount_pretax	Double	Total summary of pretax quotation discount.
discountamount_vat	Double	Total summary of quotation vat.
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
pricepernumber_pretax	Double	Pretax Product Price/Quantity
pricepernumber_vat	Double	Product Vat/Quantity
discount	String	Discount Per Unit
discountamount	Double	Total discount of product line.
discountamount_pretax	Double	Total pretax discount of product line.
discountamount_vat	Double	Total discount vat of product line.
totalprice	Double	Total Price
totalprice_pretax	Double	Pretax Total Price
totalprice_vat	Double	Total Vat
bundleid	Int (Nullable)	Bundle ID
bundleitemid	Int (Nullable)	ID of bundle group in product line.

Add Quotation

POST https://open-api.zortout.com/v4/Quotation/AddQuotation

Add quotation.

Query Parameters

Name	Type	Description
uniquenumber	String	Unique Number. This value is unique and used to prevent duplicate transaction.

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)

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description
detail	Detail	Detail

Detail	Type	Description/Example
id	Int	Quotation ID

Ex. Request JSON

{
  "number": "QT-0001",
  "quotationdate": "2021-05-31",
  "amount": 68,
  "shippingamount": 10,
  "vatamount": 0,
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": 24,
      "pricepernumber": 2,
      "discount": "0",
      "totalprice": 48
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": 1,
      "pricepernumber": 10,
      "discount": "0",
      "totalprice": 10
    }
  ]
}

Approve Quotation

POST https://open-api.zortout.com/v4/Quotation/ApproveQuotation

Approve quotation.

Query Parameters

Name	Type	Description
id	Int	Quotation ID *Must have either id or number
number	String	Quotation Number Require if id = 0 or null *Must have either id or number
approvedate	String	Approve Date (yyyy-MM-dd)

Headers

Name	Type	Description
storename*	String	Store Name
apikey*	String	API Key
apisecret*	String	API Secret

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Edit Quotation Info

POST https://open-api.zortout.com/v4/Quotation/EditQuotationInfo

Edit quotation info.

Query Parameters

Name	Type	Description
id	Int	Quotation ID *Must have either id or number
number	String	Quotation Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
apisecret*	String	API Secret
apikey*	String	API Key
storename*	String	Store Name

Request Body

Name	Type	Description
number	String	Quotation Number
customerphone	String	Customer Phone
customeremail	String	Customer Email
customeridnumber	String	Customer ID Number/Tax ID
customername	String	Customer Name
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
saleschannel	String	Sales Channel
description	String	Description
tag	String (Array)	Tag List (Array)

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

{
  "number": "QT-0001",
  "quotationdate": "2021-05-31"
}

Edit Quotation

POST https://open-api.zortout.com/v4/Quotation/EditQuotation

Edit quotation.

Query Parameters

Name	Type	Description
id	Int	Quotation ID *Must have either id or number
number	String	Quotation Number Require if id = 0 or null *Must have either id or number

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
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
quotationdate	String	Quotation Date Ex. "2021-09-15"
reference	String	Reference
customerbranchno	String	Customer Branch No
saleschannel	String	Sales Channel
description	String	Description
tag	String (Array)	Tag List (Array)
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
∟ 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
∟ pricepernumber*	Double	Product Price/Quantity
∟ number*	Double	Product Quantity
∟ totalprice*	Double	Total Price
∟ discount	String	Discount Per Unit

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description

Ex. Request JSON

{
  "number": "QT-0001",
  "quotationdate": "2021-05-31",
  "amount": 68,
  "shippingamount": 10,
  "vatamount": 0,
  "list": [
    {
      "sku": "P0001",
      "name": "Product1",
      "number": 24,
      "pricepernumber": 2,
      "discount": "0",
      "totalprice": 48
    },
    {
      "sku": "P0002",
      "name": "Product2",
      "number": 1,
      "pricepernumber": 10,
      "discount": "0",
      "totalprice": 10
    }
  ]
}

Void Quotation

POST https://open-api.zortout.com/v4/Quotation/VoidQuotation

Void quotation.

Query Parameters

Name	Type	Description
id	Int	Quotation ID *Must have either id or number
number	String	Quotation Number Require if id = 0 or null *Must have either id or number

Headers

Name	Type	Description
storename*	String	Store Name
apisecret*	String	API Secret
apikey*	String	API Key

200: OK Success

Response

Parameter	Type	Description/Example
resCode	String	Response Code 200- Success
resDesc	String	Response Description