curl --request GET \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/itemsimport requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"customId": "<string>",
"description": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"organization": {
"id": 123,
"name": "<string>"
},
"supplier": {
"id": 123,
"name": "<string>"
},
"companyContactPerson": {
"id": "<string>",
"name": "<string>"
},
"supplierContactPerson": {
"id": "<string>",
"name": "<string>"
},
"adminUnit": {
"id": 123,
"name": "<string>",
"properties": [
"<string>"
]
},
"logo": {
"id": "<string>",
"url": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"erpItemId": "<string>",
"defaultQty": 123,
"nameGeneratorExtraText": "<string>",
"physicalReferenceNumber": "<string>",
"categories": [
{
"id": 123,
"name": "<string>",
"state": "active",
"usedInItems": 123,
"beginDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"properties": [
"<string>"
]
}
],
"customFields": [
{
"id": 123,
"customId1": "<string>",
"type": "<string>",
"name": "<string>",
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
],
"perColorValues": [
{
"styleColorId": 123,
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
]
}
]
}
],
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Get items
Retrieves a paginated list of items. Supply filter + sort + pageSize + pageNumber for page-based results, or a cursor for cursor-based results. cursor is mutually exclusive with filter/sort/pageSize/pageNumber.
curl --request GET \
--url https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/itemsimport requests
url = "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items")
.asString();require 'uri'
require 'net/http'
url = URI("https://ca-delogue-service-prod.bravepebble-62e34dbe.westeurope.azurecontainerapps.io/api/items")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"status": "success",
"code": "<string>",
"data": [
{
"id": 123,
"name": "<string>",
"customId": "<string>",
"description": "<string>",
"brand": {
"id": 123,
"name": "<string>"
},
"organization": {
"id": 123,
"name": "<string>"
},
"supplier": {
"id": 123,
"name": "<string>"
},
"companyContactPerson": {
"id": "<string>",
"name": "<string>"
},
"supplierContactPerson": {
"id": "<string>",
"name": "<string>"
},
"adminUnit": {
"id": 123,
"name": "<string>",
"properties": [
"<string>"
]
},
"logo": {
"id": "<string>",
"url": "<string>"
},
"lastUpdated": "2023-11-07T05:31:56Z",
"deadline": "2023-11-07T05:31:56Z",
"etd": "2023-11-07T05:31:56Z",
"erpItemId": "<string>",
"defaultQty": 123,
"nameGeneratorExtraText": "<string>",
"physicalReferenceNumber": "<string>",
"categories": [
{
"id": 123,
"name": "<string>",
"state": "active",
"usedInItems": 123,
"beginDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"properties": [
"<string>"
]
}
],
"customFields": [
{
"id": 123,
"customId1": "<string>",
"type": "<string>",
"name": "<string>",
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
],
"perColorValues": [
{
"styleColorId": 123,
"value": {
"id": 123,
"value": "<string>",
"customId": "<string>"
},
"values": [
{
"id": 123,
"value": "<string>",
"customId": "<string>"
}
]
}
]
}
],
"properties": [
"<string>"
]
}
],
"pagination": {
"hasMore": true,
"cursor": "<string>"
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}{
"status": "success",
"code": "<string>",
"error": {
"details": [
{
"type": "<string>",
"field": "<string>",
"value": "<string>"
}
]
}
}Headers
Query Parameters
Free-text search matching items by name, item number, or description.
Filters to items whose name matches the given text.
Filters by item number, the customer-defined identifier.
Filters to items whose description matches the given text.
Filters to items belonging to any of the given brand ids.
Filters to items assigned to any of the given supplier organization ids.
Filters to items whose brand-side contact person is any of the given user ids.
Filters to items whose supplier-side contact person is any of the given user ids.
Filters to items belonging to any of the given item category ids.
Filters to items using any of the given unit ids.
Lower bound, inclusive, for the item's default quantity.
Upper bound, inclusive, for the item's default quantity.
Filters by active status. Pass 1 for active items or 0 for inactive items.
Filters by ready-for-export status. Pass 1 for ready items or 0 for not-ready items.
Filters by last-updated date range. Pass two timestamps as the inclusive from and to bounds.
Filters by custom field values. Each entry matches items on the given field's values, allowed-value ids, or date range.
Show child attributes
Show child attributes
Repeat the parameter per sort column: sort[0].property=<column>&sort[0].order=Ascending|Descending, sort[1].... for a secondary column. order accepts asc, desc, ascending or descending (case-insensitive) and may also be spelled direction. Mutually exclusive with cursor. Sortable columns include: Id, Name, UserDefinedId, Brand, Supplier, CompanyContactPerson, SupplierContactPerson, IsActive, ReadyForExport, LastUpdated, Deadline, ETD, AdminUnit, DefaultQty.
Show child attributes
Show child attributes
The maximum number of items to return per page. Defaults to 30, maximum 100.
The 1-based page number to return. Defaults to 1.
An opaque keyset pagination token. Mutually exclusive with the filter, sort, pageSize, and pageNumber parameters.
Response
OK
The coarse outcome of the request, indicating whether it succeeded or failed.
success, error The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.
The page of results, always an array. An empty page is an empty array rather than null or an omitted field.
Show child attributes
Show child attributes
Paging metadata for this response, carrying whether more rows remain and the cursor used to request the next page.
Show child attributes
Show child attributes