GET orders/objetcrm/{crmobjet_id}?session={session}&page={page}&count={count}&filter={filter}&statut={statut}&divisionId={divisionId}&docId={docId}&includeChildrenDivisions={includeChildrenDivisions}

Back

Returns a page of orders based on the page, count, and filter parameters for a given crm object

Request

URL parameters

Name	Description	Type	Additionnal Information
crmobjet_id	Customer unique identifier	bigint	Required
session	Session identification. (Must be unique for the current session)	string	Length between 0 and 100
page	List page number	integer
count	Number of orders to return by page	integer	Default value: 20 Value between 1 and 100
filter	Order filters	string
statut	Filter by status for orders	integer
divisionId	Division filter	bigint
docId	Document filter	bigint
includeChildrenDivisions	Include child divisions	integer

Response

OrderListResult

Name	Description	Type
order	Order list	Collection of OrderList
token	Token of this result's last entry. This token can be passed the next time you call this API to get the rest of the modified data	string
count	Number of entries in this lot	integer
queuecount	Number of remaining prices to recover	integer
returncode	Return code: 0 for success	integer
returnmsg	Return message	string
warnings	Warnings (the instruction worked but you need to pay attention to warnings. May cause partial data loss (Truncation))	Collection of string
version	API version	string

Return format

application/json, text/json, application/x-www-form-urlencoded

Sample:

{
  "order": [
    {
      "order_id": 1,
      "order_no": "sample string 2",
      "status": "sample string 3",
      "order_date": "2024-07-03",
      "po_no": "sample string 5",
      "sub_total": 6.1,
      "taxcode_1": "sample string 7",
      "tax_amount_1": 8.1,
      "taxcode_2": "sample string 9",
      "tax_amount_2": 10.1,
      "taxcode_3": "sample string 11",
      "tax_amount_3": 12.1,
      "total": 13.1,
      "status_fr": "sample string 14",
      "status_en": "sample string 15",
      "status_code": 16,
      "tracking_no": "sample string 17",
      "entr_code": "sample string 18",
      "weborderid": "sample string 19",
      "crmobjet_id": 20,
      "codedoc": "sample string 21",
      "delivery_no": "sample string 22",
      "invoice_no": "sample string 23",
      "invoice_id": 24,
      "project_title": "sample string 25",
      "cust_id": 26,
      "prospect_id": 27,
      "bill_cust_id": 28,
      "magentoStatus": "sample string 29",
      "divisionId": 30,
      "invoiceDownloadURL": "sample string 31"
    },
    {
      "order_id": 1,
      "order_no": "sample string 2",
      "status": "sample string 3",
      "order_date": "2024-07-03",
      "po_no": "sample string 5",
      "sub_total": 6.1,
      "taxcode_1": "sample string 7",
      "tax_amount_1": 8.1,
      "taxcode_2": "sample string 9",
      "tax_amount_2": 10.1,
      "taxcode_3": "sample string 11",
      "tax_amount_3": 12.1,
      "total": 13.1,
      "status_fr": "sample string 14",
      "status_en": "sample string 15",
      "status_code": 16,
      "tracking_no": "sample string 17",
      "entr_code": "sample string 18",
      "weborderid": "sample string 19",
      "crmobjet_id": 20,
      "codedoc": "sample string 21",
      "delivery_no": "sample string 22",
      "invoice_no": "sample string 23",
      "invoice_id": 24,
      "project_title": "sample string 25",
      "cust_id": 26,
      "prospect_id": 27,
      "bill_cust_id": 28,
      "magentoStatus": "sample string 29",
      "divisionId": 30,
      "invoiceDownloadURL": "sample string 31"
    }
  ],
  "token": "sample string 1",
  "count": 2,
  "queuecount": 3,
  "returncode": 4,
  "returnmsg": "sample string 5",
  "warnings": [
    "sample string 1",
    "sample string 2"
  ],
  "version": "sample string 6"
}

application/xml, text/xml

Sample:

<result returncode="4" returnmsg="sample string 5" version="sample string 6" token="sample string 1" count="2" queuecount="3">
  <warnings>sample string 1</warnings>
  <warnings>sample string 2</warnings>
  <order order_id="1" order_no="sample string 2" status="sample string 3" order_date="2024-07-03T17:42:31.3184323-04:00" po_no="sample string 5" sub_total="6.1" taxcode_1="sample string 7" tax_amount_1="8.1" taxcode_2="sample string 9" tax_amount_2="10.1" taxcode_3="sample string 11" tax_amount_3="12.1" total="13.1" status_fr="sample string 14" status_en="sample string 15" status_code="16" tracking_no="sample string 17" entr_code="sample string 18" weborderid="sample string 19" crmobjet_id="20" codedoc="sample string 21" delivery_no="sample string 22" invoice_no="sample string 23" invoice_id="24" project_title="sample string 25" cust_id="26" prospect_id="27" bill_cust_id="28" magentoStatus="sample string 29" divisionId="30" invoiceDownloadURL="sample string 31" />
  <order order_id="1" order_no="sample string 2" status="sample string 3" order_date="2024-07-03T17:42:31.3184323-04:00" po_no="sample string 5" sub_total="6.1" taxcode_1="sample string 7" tax_amount_1="8.1" taxcode_2="sample string 9" tax_amount_2="10.1" taxcode_3="sample string 11" tax_amount_3="12.1" total="13.1" status_fr="sample string 14" status_en="sample string 15" status_code="16" tracking_no="sample string 17" entr_code="sample string 18" weborderid="sample string 19" crmobjet_id="20" codedoc="sample string 21" delivery_no="sample string 22" invoice_no="sample string 23" invoice_id="24" project_title="sample string 25" cust_id="26" prospect_id="27" bill_cust_id="28" magentoStatus="sample string 29" divisionId="30" invoiceDownloadURL="sample string 31" />
</result>