The External Order Management section of the InvenTree API schema is documented below.
InvenTree API 294¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
order¶
GET /api/order/po-extra-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderExtraLine"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po-extra-line/¶
Description
API endpoint for accessing a list of PurchaseOrderExtraLine objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/order/po-extra-line/{id}/¶
Description
API endpoint for detail view of a PurchaseOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/po-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
DELETE /api/order/po-line/¶
Description
Perform a DELETE operation against this list endpoint.
We expect a list of primary-key (ID) values to be supplied as a JSON object, e.g. { items: [4, 8, 15, 16, 23, 42] }
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 204 No Content
GET /api/order/po-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
base_part |
query | string | No | Internal Part | |
has_pricing |
query | boolean | No | Has Pricing | |
include_variants |
query | boolean | No | Include Variants | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | Order | |
order_complete |
query | boolean | No | Order Complete | |
order_status |
query | integer | No | Order Status | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Supplier Part | |
pending |
query | boolean | No | Order Pending | |
received |
query | boolean | No | Items Received | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItem"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po-line/¶
Description
API endpoint for accessing a list of PurchaseOrderLineItem objects.
- GET: Return a list of PurchaseOrder Line Item objects
- POST: Create a new PurchaseOrderLineItem object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
DELETE /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
PATCH /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"type": "object"
}
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
PUT /api/order/po-line/{id}/¶
Description
Detail API endpoint for PurchaseOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the request body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
Response 200 OK
{
"auto_pricing": true,
"destination": 0,
"destination_detail": null,
"internal_part": 0,
"internal_part_name": "string",
"ipn": "string",
"link": "string",
"merge_items": true,
"mpn": "string",
"notes": "string",
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"purchase_price": "string",
"purchase_price_currency": null,
"quantity": 10.12,
"received": 10.12,
"reference": "string",
"sku": "string",
"target_date": "2022-04-13",
"total_price": 10.12
}
Schema of the response body
{
"description": "Serializer class for the PurchaseOrderLineItem model.",
"properties": {
"auto_pricing": {
"default": true,
"description": "Automatically calculate purchase price based on supplier part data",
"type": "boolean"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"destination_detail": {
"allOf": [
{
"$ref": "#/components/schemas/LocationBrief"
}
],
"readOnly": true
},
"internal_part": {
"readOnly": true,
"type": "integer"
},
"internal_part_name": {
"readOnly": true,
"type": "string"
},
"ipn": {
"readOnly": true,
"title": "Internal Part Number",
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"merge_items": {
"default": true,
"description": "Merge items with the same part, destination and target date into one line item",
"type": "boolean",
"writeOnly": true
},
"mpn": {
"readOnly": true,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Purchase Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"nullable": true,
"title": "Supplier Part",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"purchase_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"purchase_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Purchase price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"minimum": 0,
"type": "number"
},
"received": {
"default": 0.0,
"format": "double",
"readOnly": true,
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sku": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "double",
"readOnly": true,
"type": "number"
}
},
"required": [
"destination_detail",
"internal_part",
"internal_part_name",
"ipn",
"mpn",
"order",
"overdue",
"part",
"pk",
"quantity",
"received",
"sku",
"total_price"
],
"type": "object"
}
GET /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/po-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/po/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
assigned_to |
query | integer | No | Responsible | |
assigned_to_me |
query | boolean | No | Assigned to me | |
completed_after |
query | string | No | Completed After | |
completed_before |
query | string | No | Completed Before | |
created_after |
query | string | No | Created After | |
created_before |
query | string | No | Created Before | |
has_project_code |
query | boolean | No | Has Project Code | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Outstanding | |
overdue |
query | boolean | No | overdue | |
part |
query | string | No | Part | |
project_code |
query | integer | No | Project Code | |
reference |
query | string | No | Order Reference | |
search |
query | string | No | A search term. | |
status |
query | integer | No | Order Status | |
supplier |
query | integer | No | ||
supplier_part |
query | string | No | Supplier Part | |
target_date_after |
query | string | No | Target Date After | |
target_date_before |
query | string | No | Target Date Before |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/PurchaseOrder"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/po/¶
Description
API endpoint for accessing a list of PurchaseOrder objects.
- GET: Return list of PurchaseOrder objects (with filters)
- POST: Create a new PurchaseOrder object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
GET /api/order/po/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
PATCH /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
PUT /api/order/po/{id}/¶
Description
API endpoint for detail view of a PurchaseOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"description": "string",
"destination": 0,
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"supplier": 0,
"supplier_name": "string",
"supplier_reference": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for a PurchaseOrder object.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"readOnly": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"destination": {
"description": "Destination for received items",
"nullable": true,
"type": "integer"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - Placed\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PurchaseOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"supplier": {
"description": "Company from which the items are being ordered",
"nullable": true,
"type": "integer"
},
"supplier_name": {
"readOnly": true,
"type": "string"
},
"supplier_reference": {
"description": "Supplier order reference code",
"maxLength": 64,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"complete_date",
"completed_lines",
"contact_detail",
"issue_date",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"supplier",
"supplier_name",
"total_price"
],
"type": "object"
}
POST /api/order/po/{id}/cancel/¶
Description
API endpoint to 'cancel' a purchase order.
The purchase order must be in a state which can be cancelled
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/po/{id}/complete/¶
Description
API endpoint to 'complete' a purchase order.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "Serializer for completing a purchase order.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "Serializer for completing a purchase order.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "Serializer for completing a purchase order.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"accept_incomplete": true
}
Schema of the response body
{
"description": "Serializer for completing a purchase order.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
POST /api/order/po/{id}/hold/¶
Description
API endpoint to place a PurchaseOrder on hold.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/po/{id}/issue/¶
Description
API endpoint to 'issue' (place) a PurchaseOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
GET /api/order/po/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/po/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/po/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/order/po/{id}/receive/¶
Description
API endpoint to receive stock items against a PurchaseOrder.
- The purchase order is specified in the URL.
- Items to receive are specified as a list called "items" with the following
options:
- line_item: pk of the PO Line item
- supplier_part: pk value of the supplier part
- quantity: quantity to receive
- status: stock item status
- location: destination for stock item (optional)
- batch_code: the batch code for this stock item
- serial_numbers: serial numbers for this stock item
- A global location must also be specified. This is used when no locations are specified for items, and no location is given in the PO line item
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"items": [
{
"barcode": "string",
"batch_code": "string",
"line_item": 0,
"location": 0,
"note": "string",
"packaging": "string",
"quantity": "string",
"serial_numbers": "string",
"status": null
}
],
"location": 0
}
Schema of the request body
{
"description": "Serializer for receiving items against a PurchaseOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"barcode": "string",
"batch_code": "string",
"line_item": 0,
"location": 0,
"note": "string",
"packaging": "string",
"quantity": "string",
"serial_numbers": "string",
"status": null
}
],
"location": 0
}
Schema of the request body
{
"description": "Serializer for receiving items against a PurchaseOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"barcode": "string",
"batch_code": "string",
"line_item": 0,
"location": 0,
"note": "string",
"packaging": "string",
"quantity": "string",
"serial_numbers": "string",
"status": null
}
],
"location": 0
}
Schema of the request body
{
"description": "Serializer for receiving items against a PurchaseOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
Response 201 Created
{
"items": [
{
"barcode": "string",
"batch_code": "string",
"line_item": 0,
"location": 0,
"note": "string",
"packaging": "string",
"quantity": "string",
"serial_numbers": "string",
"status": null
}
],
"location": 0
}
Schema of the response body
{
"description": "Serializer for receiving items against a PurchaseOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PurchaseOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
GET /api/order/ro-extra-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ReturnOrderExtraLine"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/ro-extra-line/¶
Description
API endpoint for accessing a list of ReturnOrderExtraLine objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/order/ro-extra-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/ro-extra-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/order/ro-extra-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/order/ro-extra-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/ro-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/ro-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/ro-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/ro-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
has_pricing |
query | boolean | No | Has Pricing | |
item |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
order_status |
query | integer | No | Order Status | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outcome |
query | integer | No | outcome | |
received |
query | boolean | No | received | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ReturnOrderLineItem"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/ro-line/¶
Description
API endpoint for accessing a list of ReturnOrderLineItemList objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/ro-line/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/order/ro-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/ro-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/order/ro-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/order/ro-line/{id}/¶
Description
API endpoint for detail view of a ReturnOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"item": 0,
"item_detail": null,
"link": "string",
"notes": "string",
"order": 0,
"outcome": null,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"received_date": "2022-04-13",
"reference": "string",
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a ReturnOrderLineItem object.",
"properties": {
"item": {
"description": "Select item to return from customer",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItem"
}
],
"readOnly": true
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Return Order",
"type": "integer"
},
"outcome": {
"allOf": [
{
"$ref": "#/components/schemas/OutcomeEnum"
}
],
"description": "Outcome for this line item\n\n* `10` - Pending\n* `20` - Return\n* `30` - Repair\n* `40` - Replace\n* `50` - Refund\n* `60` - Reject"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Line price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"description": "Quantity to return",
"format": "double",
"type": "number"
},
"received_date": {
"description": "The date this this return item was received",
"format": "date",
"nullable": true,
"type": "string"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"item",
"item_detail",
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/ro-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/ro-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/ro-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/ro/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
assigned_to |
query | integer | No | Responsible | |
assigned_to_me |
query | boolean | No | Assigned to me | |
completed_after |
query | string | No | Completed After | |
completed_before |
query | string | No | Completed Before | |
created_after |
query | string | No | Created After | |
created_before |
query | string | No | Created Before | |
customer |
query | integer | No | ||
has_project_code |
query | boolean | No | Has Project Code | |
include_variants |
query | boolean | No | Include Variants | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Outstanding | |
overdue |
query | boolean | No | overdue | |
part |
query | string | No | ||
project_code |
query | integer | No | Project Code | |
reference |
query | string | No | Order Reference | |
search |
query | string | No | A search term. | |
status |
query | integer | No | Order Status | |
target_date_after |
query | string | No | Target Date After | |
target_date_before |
query | string | No | Target Date Before |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/ReturnOrder"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/ro/¶
Description
API endpoint for accessing a list of ReturnOrder objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
GET /api/order/ro/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/order/ro/{id}/¶
Description
API endpoint for detail view of a single ReturnOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/ro/{id}/¶
Description
API endpoint for detail view of a single ReturnOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
PATCH /api/order/ro/{id}/¶
Description
API endpoint for detail view of a single ReturnOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
PUT /api/order/ro/{id}/¶
Description
API endpoint for detail view of a single ReturnOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"complete_date": "2022-04-13",
"completed_lines": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"issue_date": "2022-04-13",
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the ReturnOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"complete_date": {
"description": "Date order was completed",
"format": "date",
"nullable": true,
"title": "Completion Date",
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company from which items are being returned",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"issue_date": {
"description": "Date order was issued",
"format": "date",
"nullable": true,
"type": "string"
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `20` - In Progress\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReturnOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
POST /api/order/ro/{id}/cancel/¶
Description
API endpoint to cancel a ReturnOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/ro/{id}/complete/¶
Description
API endpoint to complete a ReturnOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/ro/{id}/hold/¶
Description
API endpoint to hold a ReturnOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/ro/{id}/issue/¶
Description
API endpoint to issue (place) a ReturnOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
GET /api/order/ro/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/ro/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/ro/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/order/ro/{id}/receive/¶
Description
API endpoint to receive items against a ReturnOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"items": [
{
"item": 0,
"status": null
}
],
"location": 0,
"note": "string"
}
Schema of the request body
{
"description": "Serializer for receiving items against a ReturnOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ReturnOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"type": "integer"
},
"note": {
"default": "",
"description": "Additional note for incoming stock items",
"type": "string"
}
},
"required": [
"items",
"location"
],
"type": "object"
}
{
"items": [
{
"item": 0,
"status": null
}
],
"location": 0,
"note": "string"
}
Schema of the request body
{
"description": "Serializer for receiving items against a ReturnOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ReturnOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"type": "integer"
},
"note": {
"default": "",
"description": "Additional note for incoming stock items",
"type": "string"
}
},
"required": [
"items",
"location"
],
"type": "object"
}
{
"items": [
{
"item": 0,
"status": null
}
],
"location": 0,
"note": "string"
}
Schema of the request body
{
"description": "Serializer for receiving items against a ReturnOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ReturnOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"type": "integer"
},
"note": {
"default": "",
"description": "Additional note for incoming stock items",
"type": "string"
}
},
"required": [
"items",
"location"
],
"type": "object"
}
Response 201 Created
{
"items": [
{
"item": 0,
"status": null
}
],
"location": 0,
"note": "string"
}
Schema of the response body
{
"description": "Serializer for receiving items against a ReturnOrder.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ReturnOrderLineItemReceive"
},
"type": "array"
},
"location": {
"description": "Select destination location for received items",
"type": "integer"
},
"note": {
"default": "",
"description": "Additional note for incoming stock items",
"type": "string"
}
},
"required": [
"items",
"location"
],
"type": "object"
}
GET /api/order/so-allocation/¶
Description
API endpoint for listing SalesOrderAllocation objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
assigned_to_shipment |
query | boolean | No | Has Shipment | |
include_variants |
query | boolean | No | Include Variants | |
item |
query | integer | No | ||
limit |
query | integer | No | Number of results to return per page. | |
line |
query | integer | No | ||
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | Order | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Outstanding | |
part |
query | string | No | Part | |
search |
query | string | No | A search term. | |
shipment |
query | integer | No |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SalesOrderAllocation"
},
"type": "array"
}
},
"type": "object"
}
DELETE /api/order/so-allocation/{id}/¶
Description
API endpoint for detali view of a SalesOrderAllocation object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/so-allocation/{id}/¶
Description
API endpoint for detali view of a SalesOrderAllocation object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the response body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
PATCH /api/order/so-allocation/{id}/¶
Description
API endpoint for detali view of a SalesOrderAllocation object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"item": 0,
"item_detail": null,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"item": 0,
"item_detail": null,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"type": "object"
}
{
"item": 0,
"item_detail": null,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"part_detail": null,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"item_detail": {
"allOf": [
{
"$ref": "#/components/schemas/StockItemSerializerBrief"
}
],
"readOnly": true
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"type": "object"
}
Response 200 OK
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the response body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
PUT /api/order/so-allocation/{id}/¶
Description
API endpoint for detali view of a SalesOrderAllocation object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the request body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
Response 200 OK
{
"item": 0,
"line": 0,
"location": 0,
"order": 0,
"part": 0,
"pk": 0,
"quantity": 10.12,
"serial": "string",
"shipment": 0,
"shipment_detail": null
}
Schema of the response body
{
"description": "Serializer for the SalesOrderAllocation model.\n\nThis includes some fields from the related model objects.",
"properties": {
"item": {
"description": "Select stock item to allocate",
"type": "integer"
},
"line": {
"readOnly": true,
"type": "integer"
},
"location": {
"readOnly": true,
"type": "integer"
},
"order": {
"readOnly": true,
"type": "integer"
},
"part": {
"readOnly": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"serial": {
"readOnly": true,
"type": "string"
},
"shipment": {
"description": "Sales order shipment reference",
"nullable": true,
"type": "integer"
},
"shipment_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrderShipment"
}
],
"readOnly": true
}
},
"required": [
"item",
"line",
"location",
"order",
"part",
"pk",
"quantity",
"serial",
"shipment_detail"
],
"type": "object"
}
GET /api/order/so-extra-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SalesOrderExtraLine"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/so-extra-line/¶
Description
API endpoint for accessing a list of SalesOrderExtraLine objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 201 Created
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
DELETE /api/order/so-extra-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/so-extra-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PATCH /api/order/so-extra-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
PUT /api/order/so-extra-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderExtraLine object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
Response 200 OK
{
"context": null,
"description": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"price": "string",
"price_currency": null,
"quantity": 10.12,
"reference": "string"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderExtraLine object.",
"properties": {
"context": {
"description": "Additional context for this line",
"nullable": true
},
"description": {
"description": "Line item description (optional)",
"maxLength": 250,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Select currency from available options\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
}
},
"required": [
"order",
"pk",
"quantity"
],
"type": "object"
}
GET /api/order/so-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/so-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/so-extra-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/so-line/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
allocated |
query | boolean | No | Allocated | |
completed |
query | boolean | No | Completed | |
has_pricing |
query | boolean | No | Has Pricing | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | Order | |
order_complete |
query | boolean | No | Order Complete | |
order_outstanding |
query | boolean | No | Order Outstanding | |
order_status |
query | integer | No | Order Status | |
ordering |
query | string | No | Which field to use when ordering the results. | |
part |
query | integer | No | Part | |
search |
query | string | No | A search term. |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SalesOrderLineItem"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/so-line/¶
Description
API endpoint for accessing a list of SalesOrderLineItem objects.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
Response 201 Created
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
DELETE /api/order/so-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/so-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
PATCH /api/order/so-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
PUT /api/order/so-line/{id}/¶
Description
API endpoint for detail view of a SalesOrderLineItem object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the request body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
Response 200 OK
{
"allocated": 10.12,
"available_stock": 10.12,
"available_variant_stock": 10.12,
"building": 10.12,
"link": "string",
"notes": "string",
"on_order": 10.12,
"order": 0,
"overdue": true,
"part": 0,
"pk": 0,
"quantity": 10.12,
"reference": "string",
"sale_price": "string",
"sale_price_currency": null,
"shipped": 10.12,
"target_date": "2022-04-13"
}
Schema of the response body
{
"description": "Serializer for a SalesOrderLineItem object.",
"properties": {
"allocated": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"available_variant_stock": {
"format": "double",
"readOnly": true,
"type": "number"
},
"building": {
"format": "double",
"readOnly": true,
"title": "In Production",
"type": "number"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Line item notes",
"maxLength": 500,
"type": "string"
},
"on_order": {
"format": "double",
"readOnly": true,
"type": "number"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"part": {
"description": "Part",
"nullable": true,
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"quantity": {
"format": "double",
"type": "number"
},
"reference": {
"description": "Line item reference",
"maxLength": 100,
"type": "string"
},
"sale_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"sale_price_currency": {
"allOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
}
],
"description": "Sale price currency\n\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"title": "Currency"
},
"shipped": {
"format": "double",
"readOnly": true,
"type": "number"
},
"target_date": {
"description": "Target date for this line item (leave blank to use the target date from the order)",
"format": "date",
"nullable": true,
"type": "string"
}
},
"required": [
"allocated",
"available_stock",
"available_variant_stock",
"building",
"on_order",
"order",
"overdue",
"pk",
"quantity",
"shipped"
],
"type": "object"
}
GET /api/order/so-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/so-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/so-line/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
GET /api/order/so/¶
Description
Override the 'get' method to check for the export query parameter.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
assigned_to |
query | integer | No | Responsible | |
assigned_to_me |
query | boolean | No | Assigned to me | |
completed_after |
query | string | No | Completed After | |
completed_before |
query | string | No | Completed Before | |
created_after |
query | string | No | Created After | |
created_before |
query | string | No | Created Before | |
customer |
query | integer | No | ||
has_project_code |
query | boolean | No | Has Project Code | |
include_variants |
query | boolean | No | Include Variants | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
outstanding |
query | boolean | No | Outstanding | |
overdue |
query | boolean | No | overdue | |
part |
query | string | No | ||
project_code |
query | integer | No | Project Code | |
reference |
query | string | No | Order Reference | |
search |
query | string | No | A search term. | |
status |
query | integer | No | Order Status | |
target_date_after |
query | string | No | Target Date After | |
target_date_before |
query | string | No | Target Date Before |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SalesOrder"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/so/¶
Description
API endpoint for accessing a list of SalesOrder objects.
- GET: Return list of SalesOrder objects (with filters)
- POST: Create a new SalesOrder
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
Response 201 Created
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
GET /api/order/so/shipment/¶
Description
API list endpoint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
delivered |
query | boolean | No | delivered | |
limit |
query | integer | No | Number of results to return per page. | |
offset |
query | integer | No | The initial index from which to return the results. | |
order |
query | integer | No | ||
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. | |
shipped |
query | boolean | No | shipped |
Response 200 OK
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
]
}
Schema of the response body
{
"properties": {
"count": {
"example": 123,
"type": "integer"
},
"next": {
"example": "http://api.example.org/accounts/?offset=400&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"previous": {
"example": "http://api.example.org/accounts/?offset=200&limit=100",
"format": "uri",
"nullable": true,
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/SalesOrderShipment"
},
"type": "array"
}
},
"type": "object"
}
POST /api/order/so/shipment/¶
Description
API list endpoint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Request body
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
Response 201 Created
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
DELETE /api/order/so/shipment/{id}/¶
Description
API detail endpooint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/so/shipment/{id}/¶
Description
API detail endpooint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
PATCH /api/order/so/shipment/{id}/¶
Description
API detail endpooint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"order_detail": null,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"order_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrder"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"order_detail": null,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"order_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrder"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"order_detail": null,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"order_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SalesOrder"
}
],
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
PUT /api/order/so/shipment/{id}/¶
Description
API detail endpooint for SalesOrderShipment model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
Response 200 OK
{
"allocated_items": 0,
"checked_by": 0,
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"notes": "string",
"order": 0,
"pk": 0,
"reference": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrderShipment class.",
"properties": {
"allocated_items": {
"readOnly": true,
"type": "integer"
},
"checked_by": {
"description": "User who checked this shipment",
"nullable": true,
"type": "integer"
},
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order": {
"description": "Sales Order",
"type": "integer"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"reference": {
"default": "1",
"description": "Shipment number",
"maxLength": 100,
"title": "Shipment",
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"required": [
"allocated_items",
"order",
"pk"
],
"type": "object"
}
GET /api/order/so/shipment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/so/shipment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/so/shipment/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
POST /api/order/so/shipment/{id}/ship/¶
Description
API endpoint for completing (shipping) a SalesOrderShipment.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for completing (shipping) a SalesOrderShipment.",
"properties": {
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for completing (shipping) a SalesOrderShipment.",
"properties": {
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the request body
{
"description": "Serializer for completing (shipping) a SalesOrderShipment.",
"properties": {
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Response 201 Created
{
"delivery_date": "2022-04-13",
"invoice_number": "string",
"link": "string",
"shipment_date": "2022-04-13",
"tracking_number": "string"
}
Schema of the response body
{
"description": "Serializer for completing (shipping) a SalesOrderShipment.",
"properties": {
"delivery_date": {
"description": "Date of delivery of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"invoice_number": {
"description": "Reference number for associated invoice",
"maxLength": 100,
"type": "string"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"shipment_date": {
"description": "Date of shipment",
"format": "date",
"nullable": true,
"type": "string"
},
"tracking_number": {
"description": "Shipment tracking information",
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
GET /api/order/so/status/¶
Description
Retrieve information about a specific status code
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
Response 200 OK
Response 400 Bad Request
DELETE /api/order/so/{id}/¶
Description
API endpoint for detail view of a SalesOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 204 No Content
GET /api/order/so/{id}/¶
Description
API endpoint for detail view of a SalesOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
PATCH /api/order/so/{id}/¶
Description
API endpoint for detail view of a SalesOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"notes": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
PUT /api/order/so/{id}/¶
Description
API endpoint for detail view of a SalesOrder object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the request body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
Response 200 OK
{
"address": 0,
"address_detail": null,
"barcode_hash": "string",
"completed_lines": 0,
"completed_shipments_count": 0,
"contact": 0,
"contact_detail": null,
"creation_date": "2022-04-13",
"customer": 0,
"customer_reference": "string",
"description": "string",
"duplicate": null,
"line_items": 0,
"link": "string",
"order_currency": null,
"overdue": true,
"pk": 0,
"project_code": 0,
"project_code_detail": null,
"project_code_label": "string",
"reference": "string",
"responsible": 0,
"responsible_detail": null,
"shipment_date": "2022-04-13",
"shipments_count": 0,
"status": 0,
"status_custom_key": null,
"status_text": "string",
"target_date": "2022-04-13",
"total_price": "string"
}
Schema of the response body
{
"description": "Serializer for the SalesOrder model class.",
"properties": {
"address": {
"description": "Company address for this order",
"nullable": true,
"type": "integer"
},
"address_detail": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"readOnly": true
},
"barcode_hash": {
"readOnly": true,
"type": "string"
},
"completed_lines": {
"readOnly": true,
"type": "integer"
},
"completed_shipments_count": {
"readOnly": true,
"title": "Completed Shipments",
"type": "integer"
},
"contact": {
"description": "Point of contact for this order",
"nullable": true,
"type": "integer"
},
"contact_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Contact"
}
],
"readOnly": true
},
"creation_date": {
"format": "date",
"nullable": true,
"type": "string"
},
"customer": {
"description": "Company to which the items are being sold",
"nullable": true,
"type": "integer"
},
"customer_reference": {
"description": "Customer order reference code",
"maxLength": 64,
"type": "string"
},
"description": {
"description": "Order description (optional)",
"maxLength": 250,
"type": "string"
},
"duplicate": {
"allOf": [
{
"$ref": "#/components/schemas/DuplicateOrder"
}
],
"description": "Specify options for duplicating this order",
"title": "Duplicate Order",
"writeOnly": true
},
"line_items": {
"readOnly": true,
"type": "integer"
},
"link": {
"description": "Link to external page",
"format": "uri",
"maxLength": 200,
"type": "string"
},
"order_currency": {
"description": "Currency for this order (leave blank to use company default)\n\n* `` - ---------\n* `AUD` - Australian Dollar\n* `CNY` - Chinese Yuan\n* `EUR` - Euro\n* `USD` - US Dollar",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalePriceCurrencyEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
]
},
"overdue": {
"readOnly": true,
"type": "boolean"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"project_code": {
"description": "Select project code for this order",
"nullable": true,
"type": "integer"
},
"project_code_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ProjectCode"
}
],
"readOnly": true
},
"project_code_label": {
"readOnly": true,
"type": "string"
},
"reference": {
"type": "string"
},
"responsible": {
"description": "User or group responsible for this order",
"nullable": true,
"type": "integer"
},
"responsible_detail": {
"allOf": [
{
"$ref": "#/components/schemas/Owner"
}
],
"readOnly": true
},
"shipment_date": {
"format": "date",
"nullable": true,
"readOnly": true,
"type": "string"
},
"shipments_count": {
"readOnly": true,
"title": "Shipments",
"type": "integer"
},
"status": {
"readOnly": true,
"title": "Order Status",
"type": "integer"
},
"status_custom_key": {
"description": "Additional status information for this item\n\n* `10` - Pending\n* `15` - In Progress\n* `20` - Shipped\n* `25` - On Hold\n* `30` - Complete\n* `40` - Cancelled\n* `50` - Lost\n* `60` - Returned",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/SalesOrderStatusCustomKeyEnum"
},
{
"$ref": "#/components/schemas/NullEnum"
}
],
"readOnly": true,
"title": "Custom status key"
},
"status_text": {
"readOnly": true,
"type": "string"
},
"target_date": {
"description": "Expected date for order delivery. Order will be overdue after this date.",
"format": "date",
"nullable": true,
"type": "string"
},
"total_price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"readOnly": true,
"type": "string"
}
},
"required": [
"address_detail",
"barcode_hash",
"completed_lines",
"completed_shipments_count",
"contact_detail",
"line_items",
"overdue",
"pk",
"project_code_detail",
"project_code_label",
"reference",
"responsible_detail",
"shipment_date",
"shipments_count",
"status",
"status_custom_key",
"status_text",
"total_price"
],
"type": "object"
}
POST /api/order/so/{id}/allocate-serials/¶
Description
API endpoint to allocation stock items against a SalesOrder, by specifying serial numbers.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"line_item": 0,
"quantity": 0,
"serial_numbers": "string",
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
"properties": {
"line_item": {
"type": "integer"
},
"quantity": {
"minimum": 1,
"type": "integer"
},
"serial_numbers": {
"description": "Enter serial numbers to allocate",
"type": "string"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"line_item",
"quantity",
"serial_numbers"
],
"type": "object"
}
{
"line_item": 0,
"quantity": 0,
"serial_numbers": "string",
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
"properties": {
"line_item": {
"type": "integer"
},
"quantity": {
"minimum": 1,
"type": "integer"
},
"serial_numbers": {
"description": "Enter serial numbers to allocate",
"type": "string"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"line_item",
"quantity",
"serial_numbers"
],
"type": "object"
}
{
"line_item": 0,
"quantity": 0,
"serial_numbers": "string",
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
"properties": {
"line_item": {
"type": "integer"
},
"quantity": {
"minimum": 1,
"type": "integer"
},
"serial_numbers": {
"description": "Enter serial numbers to allocate",
"type": "string"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"line_item",
"quantity",
"serial_numbers"
],
"type": "object"
}
Response 201 Created
{
"line_item": 0,
"quantity": 0,
"serial_numbers": "string",
"shipment": 0
}
Schema of the response body
{
"description": "DRF serializer for allocation of serial numbers against a sales order / shipment.",
"properties": {
"line_item": {
"type": "integer"
},
"quantity": {
"minimum": 1,
"type": "integer"
},
"serial_numbers": {
"description": "Enter serial numbers to allocate",
"type": "string"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"line_item",
"quantity",
"serial_numbers"
],
"type": "object"
}
POST /api/order/so/{id}/allocate/¶
Description
API endpoint to allocate stock items against a SalesOrder.
- The SalesOrder is specified in the URL
- See the SalesOrderShipmentAllocationSerializer class
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"items": [
{
"line_item": 0,
"quantity": "string",
"stock_item": 0
}
],
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of stock items against a sales order / shipment.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
},
"type": "array"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"line_item": 0,
"quantity": "string",
"stock_item": 0
}
],
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of stock items against a sales order / shipment.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
},
"type": "array"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
{
"items": [
{
"line_item": 0,
"quantity": "string",
"stock_item": 0
}
],
"shipment": 0
}
Schema of the request body
{
"description": "DRF serializer for allocation of stock items against a sales order / shipment.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
},
"type": "array"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
Response 201 Created
{
"items": [
{
"line_item": 0,
"quantity": "string",
"stock_item": 0
}
],
"shipment": 0
}
Schema of the response body
{
"description": "DRF serializer for allocation of stock items against a sales order / shipment.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SalesOrderShipmentAllocationItem"
},
"type": "array"
},
"shipment": {
"nullable": true,
"type": "integer"
}
},
"required": [
"items"
],
"type": "object"
}
POST /api/order/so/{id}/cancel/¶
Description
API endpoint to cancel a SalesOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/so/{id}/complete/¶
Description
API endpoint for manually marking a SalesOrder as "complete".
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "DRF serializer for manually marking a sales order as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "DRF serializer for manually marking a sales order as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
{
"accept_incomplete": true
}
Schema of the request body
{
"description": "DRF serializer for manually marking a sales order as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
Response 201 Created
{
"accept_incomplete": true
}
Schema of the response body
{
"description": "DRF serializer for manually marking a sales order as complete.",
"properties": {
"accept_incomplete": {
"default": false,
"description": "Allow order to be closed with incomplete line items",
"type": "boolean"
}
},
"type": "object"
}
POST /api/order/so/{id}/hold/¶
Description
API endpoint to place a SalesOrder on hold.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
POST /api/order/so/{id}/issue/¶
Description
API endpoint to issue a SalesOrder.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 201 Created
GET /api/order/so/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PATCH /api/order/so/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
PUT /api/order/so/{id}/metadata/¶
Description
Generic API endpoint for reading and editing metadata for a model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
cookieAuth |
cookie | string | N/A | No | API key |
basicAuth |
header | string | N/A | No | Basic authentication |
tokenAuth |
header | string | N/A | No | Token-based authentication with required prefix "Token" |
id |
path | integer | No |
Request body
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
{
"metadata": null
}
Schema of the request body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Response 200 OK
{
"metadata": null
}
Schema of the response body
{
"description": "Serializer class for model metadata API access.",
"properties": {
"metadata": {}
},
"required": [
"metadata"
],
"type": "object"
}
Schemas¶
AddressBrief¶
| Name | Type |
|---|---|
country |
string |
internal_shipping_notes |
string |
line1 |
string |
line2 |
string |
pk |
integer |
postal_city |
string |
postal_code |
string |
province |
string |
shipping_notes |
string |
BlankEnum¶
Type:
Contact¶
| Name | Type |
|---|---|
company |
integer |
company_name |
string |
email |
string(email) |
name |
string |
phone |
string |
pk |
integer |
role |
string |
DuplicateOrder¶
| Name | Type |
|---|---|
copy_extra_lines |
boolean |
copy_lines |
boolean |
order_id |
integer |
LocationBrief¶
| Name | Type |
|---|---|
name |
string |
pathstring |
string |
pk |
integer |
Metadata¶
| Name | Type |
|---|---|
metadata |
NullEnum¶
Type:
OutcomeEnum¶
Type: integer
Owner¶
| Name | Type |
|---|---|
label |
string |
name |
string |
owner_id |
integer| null |
pk |
integer |
PaginatedPurchaseOrderExtraLineList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PurchaseOrderExtraLine> |
PaginatedPurchaseOrderLineItemList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PurchaseOrderLineItem> |
PaginatedPurchaseOrderList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<PurchaseOrder> |
PaginatedReturnOrderExtraLineList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReturnOrderExtraLine> |
PaginatedReturnOrderLineItemList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReturnOrderLineItem> |
PaginatedReturnOrderList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<ReturnOrder> |
PaginatedSalesOrderAllocationList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrderAllocation> |
PaginatedSalesOrderExtraLineList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrderExtraLine> |
PaginatedSalesOrderLineItemList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrderLineItem> |
PaginatedSalesOrderList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrder> |
PaginatedSalesOrderShipmentList¶
| Name | Type |
|---|---|
count |
integer |
next |
string(uri)| null |
previous |
string(uri)| null |
results |
Array<SalesOrderShipment> |
PartBrief¶
| Name | Type |
|---|---|
active |
boolean |
assembly |
boolean |
barcode_hash |
string |
category_default_location |
integer |
component |
boolean |
default_location |
integer| null |
description |
string |
full_name |
string |
image |
string(uri) |
IPN |
string| null |
is_template |
boolean |
locked |
boolean |
name |
string |
pk |
integer |
purchaseable |
boolean |
revision |
string| null |
salable |
boolean |
testable |
boolean |
thumbnail |
string |
trackable |
boolean |
units |
string| null |
virtual |
boolean |
PatchedMetadata¶
| Name | Type |
|---|---|
metadata |
PatchedPurchaseOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
complete_date |
string(date)| null |
completed_lines |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
description |
string |
destination |
integer| null |
duplicate |
|
issue_date |
string(date)| null |
line_items |
integer |
link |
string(uri) |
notes |
string| null |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
status |
integer |
status_custom_key |
|
status_text |
string |
supplier |
integer| null |
supplier_name |
string |
supplier_reference |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
PatchedPurchaseOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
PatchedPurchaseOrderLineItem¶
| Name | Type |
|---|---|
auto_pricing |
boolean |
destination |
integer| null |
destination_detail |
|
internal_part |
integer |
internal_part_name |
string |
ipn |
string |
link |
string(uri) |
merge_items |
boolean |
mpn |
string |
notes |
string |
order |
integer |
overdue |
boolean |
part |
integer| null |
pk |
integer |
purchase_price |
string(decimal)| null |
purchase_price_currency |
|
quantity |
number(double) |
received |
number(double) |
reference |
string |
sku |
string |
target_date |
string(date)| null |
total_price |
number(double) |
PatchedReturnOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
complete_date |
string(date)| null |
completed_lines |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
customer |
integer| null |
customer_reference |
string |
description |
string |
duplicate |
|
issue_date |
string(date)| null |
line_items |
integer |
link |
string(uri) |
notes |
string| null |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
status |
integer |
status_custom_key |
|
status_text |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
PatchedReturnOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
PatchedReturnOrderLineItem¶
| Name | Type |
|---|---|
item |
integer |
item_detail |
|
link |
string(uri) |
notes |
string |
order |
integer |
outcome |
|
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
received_date |
string(date)| null |
reference |
string |
target_date |
string(date)| null |
PatchedSalesOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
completed_lines |
integer |
completed_shipments_count |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
customer |
integer| null |
customer_reference |
string |
description |
string |
duplicate |
|
line_items |
integer |
link |
string(uri) |
notes |
string| null |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
shipment_date |
string(date)| null |
shipments_count |
integer |
status |
integer |
status_custom_key |
|
status_text |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
PatchedSalesOrderAllocation¶
| Name | Type |
|---|---|
item |
integer |
item_detail |
|
line |
integer |
location |
integer |
order |
integer |
part |
integer |
part_detail |
|
pk |
integer |
quantity |
number(double) |
serial |
string |
shipment |
integer| null |
shipment_detail |
PatchedSalesOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
PatchedSalesOrderLineItem¶
| Name | Type |
|---|---|
allocated |
number(double) |
available_stock |
number(double) |
available_variant_stock |
number(double) |
building |
number(double) |
link |
string(uri) |
notes |
string |
on_order |
number(double) |
order |
integer |
overdue |
boolean |
part |
integer| null |
pk |
integer |
quantity |
number(double) |
reference |
string |
sale_price |
string(decimal)| null |
sale_price_currency |
|
shipped |
number(double) |
target_date |
string(date)| null |
PatchedSalesOrderShipment¶
| Name | Type |
|---|---|
allocated_items |
integer |
checked_by |
integer| null |
delivery_date |
string(date)| null |
invoice_number |
string |
link |
string(uri) |
notes |
string| null |
order |
integer |
order_detail |
|
pk |
integer |
reference |
string |
shipment_date |
string(date)| null |
tracking_number |
string |
ProjectCode¶
| Name | Type |
|---|---|
code |
string |
description |
string |
pk |
integer |
responsible |
integer| null |
responsible_detail |
PurchaseOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
complete_date |
string(date)| null |
completed_lines |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
description |
string |
destination |
integer| null |
duplicate |
|
issue_date |
string(date)| null |
line_items |
integer |
link |
string(uri) |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
status |
integer |
status_custom_key |
|
status_text |
string |
supplier |
integer| null |
supplier_name |
string |
supplier_reference |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
PurchaseOrderComplete¶
| Name | Type |
|---|---|
accept_incomplete |
boolean |
PurchaseOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
PurchaseOrderLineItem¶
| Name | Type |
|---|---|
auto_pricing |
boolean |
destination |
integer| null |
destination_detail |
|
internal_part |
integer |
internal_part_name |
string |
ipn |
string |
link |
string(uri) |
merge_items |
boolean |
mpn |
string |
notes |
string |
order |
integer |
overdue |
boolean |
part |
integer| null |
pk |
integer |
purchase_price |
string(decimal)| null |
purchase_price_currency |
|
quantity |
number(double) |
received |
number(double) |
reference |
string |
sku |
string |
target_date |
string(date)| null |
total_price |
number(double) |
PurchaseOrderLineItemReceive¶
| Name | Type |
|---|---|
barcode |
string| null |
batch_code |
string |
line_item |
integer |
location |
integer| null |
note |
string |
packaging |
string |
quantity |
string(decimal) |
serial_numbers |
string |
status |
PurchaseOrderReceive¶
| Name | Type |
|---|---|
items |
Array<PurchaseOrderLineItemReceive> |
location |
integer| null |
PurchaseOrderStatusCustomKeyEnum¶
Type: integer
ReturnOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
complete_date |
string(date)| null |
completed_lines |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
customer |
integer| null |
customer_reference |
string |
description |
string |
duplicate |
|
issue_date |
string(date)| null |
line_items |
integer |
link |
string(uri) |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
status |
integer |
status_custom_key |
|
status_text |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
ReturnOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
ReturnOrderLineItem¶
| Name | Type |
|---|---|
item |
integer |
item_detail |
|
link |
string(uri) |
notes |
string |
order |
integer |
outcome |
|
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
received_date |
string(date)| null |
reference |
string |
target_date |
string(date)| null |
ReturnOrderLineItemReceive¶
| Name | Type |
|---|---|
item |
integer |
status |
ReturnOrderReceive¶
| Name | Type |
|---|---|
items |
Array<ReturnOrderLineItemReceive> |
location |
integer |
note |
string |
ReturnOrderStatusCustomKeyEnum¶
Type: integer
SalePriceCurrencyEnum¶
Type: string
SalesOrder¶
| Name | Type |
|---|---|
address |
integer| null |
address_detail |
|
barcode_hash |
string |
completed_lines |
integer |
completed_shipments_count |
integer |
contact |
integer| null |
contact_detail |
|
creation_date |
string(date)| null |
customer |
integer| null |
customer_reference |
string |
description |
string |
duplicate |
|
line_items |
integer |
link |
string(uri) |
order_currency |
|
overdue |
boolean |
pk |
integer |
project_code |
integer| null |
project_code_detail |
|
project_code_label |
string |
reference |
string |
responsible |
integer| null |
responsible_detail |
|
shipment_date |
string(date)| null |
shipments_count |
integer |
status |
integer |
status_custom_key |
|
status_text |
string |
target_date |
string(date)| null |
total_price |
string(decimal)| null |
SalesOrderAllocation¶
| Name | Type |
|---|---|
item |
integer |
line |
integer |
location |
integer |
order |
integer |
part |
integer |
pk |
integer |
quantity |
number(double) |
serial |
string |
shipment |
integer| null |
shipment_detail |
SalesOrderComplete¶
| Name | Type |
|---|---|
accept_incomplete |
boolean |
SalesOrderExtraLine¶
| Name | Type |
|---|---|
context |
|
description |
string |
link |
string(uri) |
notes |
string |
order |
integer |
pk |
integer |
price |
string(decimal)| null |
price_currency |
|
quantity |
number(double) |
reference |
string |
SalesOrderLineItem¶
| Name | Type |
|---|---|
allocated |
number(double) |
available_stock |
number(double) |
available_variant_stock |
number(double) |
building |
number(double) |
link |
string(uri) |
notes |
string |
on_order |
number(double) |
order |
integer |
overdue |
boolean |
part |
integer| null |
pk |
integer |
quantity |
number(double) |
reference |
string |
sale_price |
string(decimal)| null |
sale_price_currency |
|
shipped |
number(double) |
target_date |
string(date)| null |
SalesOrderSerialAllocation¶
| Name | Type |
|---|---|
line_item |
integer |
quantity |
integer |
serial_numbers |
string |
shipment |
integer| null |
SalesOrderShipment¶
| Name | Type |
|---|---|
allocated_items |
integer |
checked_by |
integer| null |
delivery_date |
string(date)| null |
invoice_number |
string |
link |
string(uri) |
notes |
string| null |
order |
integer |
pk |
integer |
reference |
string |
shipment_date |
string(date)| null |
tracking_number |
string |
SalesOrderShipmentAllocation¶
| Name | Type |
|---|---|
items |
Array<SalesOrderShipmentAllocationItem> |
shipment |
integer| null |
SalesOrderShipmentAllocationItem¶
| Name | Type |
|---|---|
line_item |
integer |
quantity |
string(decimal) |
stock_item |
integer |
SalesOrderShipmentComplete¶
| Name | Type |
|---|---|
delivery_date |
string(date)| null |
invoice_number |
string |
link |
string(uri) |
shipment_date |
string(date)| null |
tracking_number |
string |
SalesOrderStatusCustomKeyEnum¶
Type: integer
Status2a7Enum¶
Type: integer
StatusCustomKey2a7Enum¶
Type: integer
StockItem¶
| Name | Type |
|---|---|
allocated |
number(double) |
barcode_hash |
string |
batch |
string| null |
belongs_to |
integer| null |
build |
integer| null |
child_items |
integer |
consumed_by |
integer| null |
customer |
integer| null |
delete_on_deplete |
boolean |
expired |
boolean |
expiry_date |
string(date)| null |
in_stock |
boolean |
installed_items |
integer |
is_building |
boolean |
link |
string(uri) |
location |
integer| null |
location_name |
string |
MPN |
string |
notes |
string| null |
owner |
integer| null |
packaging |
string| null |
parent |
integer |
part |
integer |
part_detail |
|
pk |
integer |
purchase_order |
integer| null |
purchase_order_reference |
string |
purchase_price |
string(decimal)| null |
purchase_price_currency |
|
quantity |
number(double) |
sales_order |
integer| null |
sales_order_reference |
string |
serial |
string| null |
SKU |
string |
stale |
boolean |
status |
|
status_custom_key |
|
status_text |
string |
stocktake_date |
string(date)| null |
supplier_part |
integer| null |
tags |
Array<string> |
tracking_items |
integer |
updated |
string(date-time)| null |
use_pack_size |
boolean| null |
StockItemSerializerBrief¶
| Name | Type |
|---|---|
barcode_hash |
string |
batch |
string| null |
location |
integer| null |
part |
integer |
part_name |
string |
pk |
integer |
quantity |
number(double) |
serial |
string| null |
supplier_part |
integer| null |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| tokenAuth | apiKey | Token-based authentication with required prefix "Token" |
More documentation¶
More information about InvenTree in the official docs
For more information: https://docs.inventree.org