Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
A valid request URL is required to generate request examples[
{
"id": 1,
"currency": null,
"deliver_by": null,
"delivery_date": null,
"estimated_ship_date": null,
"shipped_date": null,
"received_date": null,
"status": "not_shipped",
"notes": null,
"tracking_number": "NUM1",
"items": [
{
"id": 1,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 32
},
{
"id": 2,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 31
},
{
"id": 3,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 30
},
{
"id": 4,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 29
},
{
"id": 5,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 28
},
{
"id": 6,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 27
},
{
"id": 7,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 26
},
{
"id": 8,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 25
},
{
"id": 9,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 24
},
{
"id": 10,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 23
},
{
"id": 11,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 22
},
{
"id": 12,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 21
},
{
"id": 13,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 20
},
{
"id": 14,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 19
},
{
"id": 15,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 18
},
{
"id": 16,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 17
},
{
"id": 17,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 16
},
{
"id": 18,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 15
},
{
"id": 19,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 14
},
{
"id": 20,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 13
},
{
"id": 21,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 12
},
{
"id": 22,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 11
},
{
"id": 23,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 10
},
{
"id": 24,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 9
},
{
"id": 25,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 8
},
{
"id": 26,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 7
},
{
"id": 27,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 6
},
{
"id": 28,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 5
},
{
"id": 29,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 4
},
{
"id": 30,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 3
},
{
"id": 31,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 2
},
{
"id": 32,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 1
}
],
"shipping_client": null,
"supplier": {
"id": 12,
"name": "Sample supplier",
"data": {
"notes": {
"value": {
"value": "This is a sample supplier"
}
},
"account": {
"value": {
"vat": null,
"terms": null,
"currency": "USD",
"lead_time": null,
"credit_limit": null,
"account_number": null,
"registration_number": null
}
},
"address": {
"value": [
{
"id": 12,
"city": "New York",
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"state": "New York",
"country": "United States of America",
"contacts": {
"value": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"note": "This is a sample supplier",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"priority": "primary"
}
]
},
"priority": "primary",
"post_code": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "info_1@supplier.com",
"status": "Approved",
"website": "www.supplier.com",
"language": null,
"password": "Password",
"user_name": "Username",
"company_name": "Sample supplier"
}
}
},
"addresses": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"postcode": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"city": "New York",
"state": "New York",
"country": "United States of America"
}
],
"people": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"note": "This is a sample supplier"
}
],
"categories": [
{
"id": 2,
"type": "supplier"
}
]
},
"purchase_order_ids": [
1
]
}
]{
"error": "Unauthorized"
}A valid request URL is required to generate request examples[
{
"id": 1,
"currency": null,
"deliver_by": null,
"delivery_date": null,
"estimated_ship_date": null,
"shipped_date": null,
"received_date": null,
"status": "not_shipped",
"notes": null,
"tracking_number": "NUM1",
"items": [
{
"id": 1,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 32
},
{
"id": 2,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 31
},
{
"id": 3,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 30
},
{
"id": 4,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 29
},
{
"id": 5,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 28
},
{
"id": 6,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 27
},
{
"id": 7,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 26
},
{
"id": 8,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 25
},
{
"id": 9,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 24
},
{
"id": 10,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 23
},
{
"id": 11,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 22
},
{
"id": 12,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 21
},
{
"id": 13,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 20
},
{
"id": 14,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 19
},
{
"id": 15,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 18
},
{
"id": 16,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 17
},
{
"id": 17,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 16
},
{
"id": 18,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 15
},
{
"id": 19,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 14
},
{
"id": 20,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 13
},
{
"id": 21,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 12
},
{
"id": 22,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 11
},
{
"id": 23,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 10
},
{
"id": 24,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 9
},
{
"id": 25,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 8
},
{
"id": 26,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 7
},
{
"id": 27,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 6
},
{
"id": 28,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 5
},
{
"id": 29,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 4
},
{
"id": 30,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 3
},
{
"id": 31,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 2
},
{
"id": 32,
"name": null,
"description": null,
"spec_quantity": 0,
"ordered": 0,
"received": 0,
"shipped": 0,
"project_item_id": 1
}
],
"shipping_client": null,
"supplier": {
"id": 12,
"name": "Sample supplier",
"data": {
"notes": {
"value": {
"value": "This is a sample supplier"
}
},
"account": {
"value": {
"vat": null,
"terms": null,
"currency": "USD",
"lead_time": null,
"credit_limit": null,
"account_number": null,
"registration_number": null
}
},
"address": {
"value": [
{
"id": 12,
"city": "New York",
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"state": "New York",
"country": "United States of America",
"contacts": {
"value": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"note": "This is a sample supplier",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"priority": "primary"
}
]
},
"priority": "primary",
"post_code": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "info_1@supplier.com",
"status": "Approved",
"website": "www.supplier.com",
"language": null,
"password": "Password",
"user_name": "Username",
"company_name": "Sample supplier"
}
}
},
"addresses": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"postcode": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"city": "New York",
"state": "New York",
"country": "United States of America"
}
],
"people": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"note": "This is a sample supplier"
}
],
"categories": [
{
"id": 2,
"type": "supplier"
}
]
},
"purchase_order_ids": [
1
]
}
]{
"error": "Unauthorized"
}1 <= x <= 50not_shipped, arrival_expected, received OK
not_shipped, arrival_expected, received Show child attributes
Show child attributes
Show child attributes