Get Orders
TestingGET
/partner/ordersLast modified: 4 months ago
Maintainer: Not configured
Request
Query Params
page
integer
optional
Default: 1
Example:
1
total
integer
optional
Default: 10
Example:
10
customer_external_id
string
optional
Filter by external customer id
sku
string
optional
Filter by product sku
sortBy
string
optional
values: created_at, total, customer_external_id
Example:
created_at
sortType
string
optional
values: asc, desc
Example:
desc
status
enum<string>
optional
example: 1,2,3
Allowed values:
CreatedPendingProcessingCancelledCompletedCanceledPreparingPackedShippedTransferringRefundingRefundedPayment Confirmed
Example:
1
tx_type
string | null
optional
default: buy,sell . example: delivery
Example:
buy,sell,delivery,ecommerce
Header Params
api-version
string
optional
Example:
2
Request samples
Responses
OK(200)
Parameter Error(422)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
object
required
current_page
integer
required
data
array[object (Order Schema) {17}]
required
first_page_url
string | null
required
from
integer
required
last_page
integer
required
last_page_url
string
required
links
array [object {3}]
required
next_page_url
string | null
optional
path
string
required
per_page
integer
required
prev_page_url
string | null
required
to
integer
required
total
integer
required
success
boolean
required
code
integer
required
message
string
required
Example
Success
{
"data": {
"current_page": 1,
"data": [
{
"guid": "47793B19-5383-492B-8BCF-7D36CD145300",
"order_code": "LGU8HFPO",
"external_id": "HYAQA01371ipdl",
"type": "Buy",
"price": 559.4,
"tax": 0,
"total": 559.4,
"currency_code": "GBP",
"items": [
{
"product_id": 3000001,
"product_name": "Gold - Digital storage",
"spot_price": 50.85,
"price": 55.94,
"tax_rate": 0,
"tax": 0,
"amount": 10,
"total": 559.4,
"sku": "GAU"
}
],
"customer": null
}
],
"first_page_url": "/?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "/?page=1",
"links": [
{
"url": null,
"label": "Önceki",
"active": false
},
{
"url": "/?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Sonraki",
"active": false
}
],
"next_page_url": null,
"path": "/",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
},
"success": true,
"code": 0,
"message": ""
}
Last modified: 4 months ago