The Company Management section of the InvenTree API schema is documented below.
InvenTree API 477¶
API for InvenTree - the intuitive open source inventory management system
License: MIT
Servers¶
| Description | URL |
|---|---|
| http://localhost:8000 | http://localhost:8000 |
company¶
GET /api/company/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
active |
query | boolean | No | ||
is_customer |
query | boolean | No | ||
is_manufacturer |
query | boolean | No | ||
is_supplier |
query | boolean | No | ||
limit |
query | integer | No | Number of results to return per page. | |
name |
query | string | No | ||
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. | |
search |
query | string | No | A search term. Searched fields: description, name, tax_id, website. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 234,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "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/Company"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/¶
Description
API endpoint for accessing a list of Company objects.
Provides two methods:
- GET: Return list of objects
- POST: Create a new Company object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 151,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 2,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 240,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
Responses
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 42,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the response body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
DELETE /api/company/address/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Responses
GET /api/company/address/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
company |
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. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "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/Address"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/address/¶
Description
API endpoint for list view of Address model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
Responses
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
DELETE /api/company/address/{id}/¶
Description
API endpoint for a single Address object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/address/{id}/¶
Description
API endpoint for a single Address object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
PATCH /api/company/address/{id}/¶
Description
API endpoint for a single Address object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"type": "object"
}
Responses
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
PUT /api/company/address/{id}/¶
Description
API endpoint for a single Address object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the request body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
Responses
{
"company": 0,
"country": "string",
"internal_shipping_notes": "string",
"line1": "string",
"line2": "string",
"link": "string",
"pk": 0,
"postal_city": "string",
"postal_code": "string",
"primary": true,
"province": "string",
"shipping_notes": "string",
"title": "string"
}
Schema of the response body
{
"description": "Serializer for the Address Model.",
"properties": {
"company": {
"description": "Select company",
"type": "integer"
},
"country": {
"description": "Address country",
"maxLength": 50,
"type": "string"
},
"internal_shipping_notes": {
"description": "Shipping notes for internal use",
"maxLength": 100,
"type": "string"
},
"line1": {
"description": "Address line 1",
"maxLength": 50,
"title": "Line 1",
"type": "string"
},
"line2": {
"description": "Address line 2",
"maxLength": 50,
"title": "Line 2",
"type": "string"
},
"link": {
"description": "Link to address information (external)",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"postal_city": {
"description": "Postal code city/region",
"maxLength": 50,
"title": "City/Region",
"type": "string"
},
"postal_code": {
"description": "Postal code",
"maxLength": 10,
"type": "string"
},
"primary": {
"description": "Set as primary address",
"title": "Primary address",
"type": "boolean"
},
"province": {
"description": "State or province",
"maxLength": 50,
"title": "State/Province",
"type": "string"
},
"shipping_notes": {
"description": "Notes for shipping courier",
"maxLength": 100,
"title": "Courier shipping notes",
"type": "string"
},
"title": {
"description": "Title describing the address entry",
"maxLength": 100,
"title": "Address title",
"type": "string"
}
},
"required": [
"company",
"pk",
"title"
],
"type": "object"
}
DELETE /api/company/contact/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Responses
GET /api/company/contact/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
company |
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. | |
ordering |
query | string | No | Which field to use when ordering the results. | |
search |
query | string | No | A search term. Searched fields: company__name, name. |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "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/Contact"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/contact/¶
Description
API endpoint for list view of Company model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
Responses
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the response body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
DELETE /api/company/contact/{id}/¶
Description
Detail endpoint for Company model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/contact/{id}/¶
Description
Detail endpoint for Company model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the response body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
PATCH /api/company/contact/{id}/¶
Description
Detail endpoint for Company model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"type": "object"
}
Responses
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the response body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
PUT /api/company/contact/{id}/¶
Description
Detail endpoint for Company model.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the request body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
Responses
{
"company": 0,
"company_name": "string",
"email": "derp@meme.org",
"name": "string",
"phone": "string",
"pk": 0,
"role": "string"
}
Schema of the response body
{
"description": "Serializer class for the Contact model.",
"properties": {
"company": {
"type": "integer"
},
"company_name": {
"readOnly": true,
"type": "string"
},
"email": {
"format": "email",
"maxLength": 254,
"type": "string"
},
"name": {
"maxLength": 100,
"type": "string"
},
"phone": {
"maxLength": 100,
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"role": {
"maxLength": 100,
"type": "string"
}
},
"required": [
"company",
"company_name",
"name",
"pk"
],
"type": "object"
}
DELETE /api/company/part/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Responses
GET /api/company/part/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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" |
active |
query | boolean | No | Supplier Part is Active | |
company |
query | integer | No | Company | |
has_stock |
query | boolean | No | Has Stock | |
limit |
query | integer | No | Number of results to return per page. | |
manufacturer |
query | integer | No | Manufacturer | |
manufacturer_detail |
query | boolean | False | No | Include detailed information about the Manufacturer in the response |
manufacturer_part |
query | integer | No | ||
manufacturer_part_detail |
query | boolean | False | No | Include detailed information about the linked ManufacturerPart in the response |
MPN |
query | string | No | Manufacturer Part Number | |
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. | |
part |
query | integer | No | ||
part_active |
query | boolean | No | Internal Part is Active | |
part_detail |
query | boolean | False | No | Include detailed information about the linked Part in the response |
pretty |
query | boolean | False | No | Format the output with a more readable (pretty) name |
primary |
query | boolean | No | Primary Supplier Part | |
search |
query | string | No | A search term. Searched fields: SKU, description, manufacturer_part__MPN, manufacturer_part__manufacturer__name, part__IPN, part__description, part__keywords, part__name, supplier__name, tags__name, tags__slug. | |
SKU |
query | string | No | ||
supplier |
query | integer | No | ||
supplier_active |
query | boolean | No | Supplier is Active | |
supplier_detail |
query | boolean | False | No | Include detailed information about the Supplier in the response |
tags__name |
query | string | No | ||
tags__slug |
query | string | No |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 68,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
]
}
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/SupplierPart"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/part/¶
Description
API endpoint for list view of SupplierPart object.
- GET: Return list of SupplierPart objects
- POST: Create a new SupplierPart object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 228,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 131,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 194,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
Responses
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 194,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
DELETE /api/company/part/manufacturer/¶
Description
Perform a DELETE operation against this list endpoint.
Note that the typical DRF list endpoint does not support DELETE, so this method is provided as a custom implementation.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
{
"filters": {},
"items": [
0
]
}
Schema of the request body
{
"description": "Parameters for selecting items for bulk operations.",
"properties": {
"filters": {
"additionalProperties": {},
"title": "A dictionary of filter values",
"type": "object"
},
"items": {
"items": {
"type": "integer"
},
"title": "A list of primary key values",
"type": "array"
}
},
"type": "object"
}
Responses
GET /api/company/part/manufacturer/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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. | |
manufacturer |
query | integer | No | ||
manufacturer_active |
query | boolean | No | Manufacturer is Active | |
manufacturer_detail |
query | boolean | False | No | Include detailed information about the Manufacturer in the response |
MPN |
query | string | No | ||
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. | |
part |
query | integer | No | ||
part_active |
query | boolean | No | Part is Active | |
part_detail |
query | boolean | False | No | Include detailed information about the linked Part in the response |
pretty |
query | boolean | False | No | Format the output with a more readable (pretty) name |
search |
query | string | No | A search term. Searched fields: MPN, description, manufacturer__name, part__IPN, part__description, part__name, tags__name, tags__slug. | |
tags__name |
query | string | No | ||
tags__slug |
query | string | No |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 264,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"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/ManufacturerPart"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/part/manufacturer/¶
Description
API endpoint for list view of ManufacturerPart object.
- GET: Return list of ManufacturerPart objects
- POST: Create a new ManufacturerPart object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 176,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 208,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 219,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
Responses
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 29,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the response body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
DELETE /api/company/part/manufacturer/{id}/¶
Description
API endpoint for detail view of ManufacturerPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/part/manufacturer/{id}/¶
Description
API endpoint for detail view of ManufacturerPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 193,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the response body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
PATCH /api/company/part/manufacturer/{id}/¶
Description
API endpoint for detail view of ManufacturerPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 247,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 216,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 185,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
Responses
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 62,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the response body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
PUT /api/company/part/manufacturer/{id}/¶
Description
API endpoint for detail view of ManufacturerPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 177,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 150,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 148,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the request body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
Responses
{
"MPN": "string",
"barcode_hash": "string",
"description": "string",
"link": "string",
"manufacturer": 0,
"manufacturer_detail": null,
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 216,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"tags": [
"string"
]
}
Schema of the response body
{
"description": "Serializer for ManufacturerPart object.",
"properties": {
"MPN": {
"description": "Manufacturer Part Number",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"maxLength": 128,
"type": "string"
},
"description": {
"description": "Manufacturer part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"link": {
"description": "URL for external manufacturer part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer": {
"type": "integer"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"manufacturer",
"part",
"pk"
],
"type": "object"
}
DELETE /api/company/part/{id}/¶
Description
API endpoint for detail view of SupplierPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/part/{id}/¶
Description
API endpoint for detail view of SupplierPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 | ||
manufacturer_detail |
query | boolean | False | No | Include detailed information about the Manufacturer in the response |
manufacturer_part_detail |
query | boolean | False | No | Include detailed information about the linked ManufacturerPart in the response |
part_detail |
query | boolean | False | No | Include detailed information about the linked Part in the response |
pretty |
query | boolean | False | No | Format the output with a more readable (pretty) name |
supplier_detail |
query | boolean | False | No | Include detailed information about the Supplier in the response |
Responses
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 280,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
PATCH /api/company/part/{id}/¶
Description
API endpoint for detail view of SupplierPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 202,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 253,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 115,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Responses
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 252,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
PUT /api/company/part/{id}/¶
Description
API endpoint for detail view of SupplierPart object.
- GET: Retrieve detail view
- PATCH: Update object
- DELETE: Delete object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 24,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 205,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 11,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
Responses
{
"MPN": "string",
"SKU": "string",
"active": true,
"availability_updated": "2022-04-13T15:42:05.901Z",
"available": 10.12,
"barcode_hash": "string",
"description": "string",
"in_stock": 10.12,
"link": "string",
"manufacturer_detail": null,
"manufacturer_part": 0,
"manufacturer_part_detail": null,
"note": "string",
"notes": "string",
"on_order": 10.12,
"pack_quantity": "string",
"pack_quantity_native": 10.12,
"packaging": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 54,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"part": 0,
"part_detail": null,
"pk": 0,
"pretty_name": "string",
"price_breaks": [
{
"part": 0,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"updated": "2022-04-13T15:42:05.901Z"
}
],
"primary": true,
"supplier": 0,
"supplier_detail": null,
"tags": [
"string"
],
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPart object.",
"properties": {
"MPN": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"SKU": {
"description": "Supplier stock keeping unit",
"maxLength": 100,
"type": "string"
},
"active": {
"description": "Is this supplier part active?",
"type": "boolean"
},
"availability_updated": {
"description": "Date of last update of availability data",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"available": {
"format": "double",
"type": "number"
},
"barcode_hash": {
"description": "Unique hash of barcode data",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Supplier part description",
"maxLength": 250,
"nullable": true,
"type": "string"
},
"in_stock": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"link": {
"description": "URL for external supplier part link",
"format": "uri",
"maxLength": 2000,
"nullable": true,
"type": "string"
},
"manufacturer_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer"
},
"manufacturer_part": {
"description": "Select manufacturer part",
"nullable": true,
"type": "integer"
},
"manufacturer_part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/ManufacturerPart"
}
],
"nullable": true,
"readOnly": true,
"title": "Manufacturer Part"
},
"note": {
"description": "Notes",
"maxLength": 100,
"nullable": true,
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"on_order": {
"format": "double",
"nullable": true,
"readOnly": true,
"type": "number"
},
"pack_quantity": {
"description": "Total quantity supplied in a single pack. Leave empty for single items.",
"maxLength": 25,
"type": "string"
},
"pack_quantity_native": {
"format": "double",
"readOnly": true,
"type": "number"
},
"packaging": {
"description": "Part packaging",
"maxLength": 50,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"part": {
"description": "Select part",
"title": "Base Part",
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/PartBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Part"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"pretty_name": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"price_breaks": {
"items": {
"$ref": "#/components/schemas/SupplierPriceBreakBrief"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"primary": {
"description": "Is this the primary supplier part for the linked Part?",
"type": "boolean"
},
"supplier": {
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true,
"title": "Supplier"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"updated": {
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"SKU",
"barcode_hash",
"pack_quantity_native",
"part",
"pk",
"supplier"
],
"type": "object"
}
GET /api/company/price-break/¶
Description
Override the GET method to determine export options.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 | integer | No | Base Part | |
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. | |
part |
query | integer | No | ||
part_detail |
query | boolean | False | No | Include detailed information about the linked Part in the response |
quantity |
query | number | No | ||
search |
query | string | No | A search term. Searched fields: part__SKU, part__supplier__name. | |
supplier |
query | integer | No | Supplier | |
supplier_detail |
query | boolean | False | No | Include detailed information about the Supplier in the response |
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100",
"results": [
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
]
}
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/SupplierPriceBreak"
},
"type": "array"
}
},
"required": [
"count",
"results"
],
"type": "object"
}
POST /api/company/price-break/¶
Description
API endpoint for list view of SupplierPriceBreak object.
- GET: Retrieve list of SupplierPriceBreak objects
- POST: Create a new SupplierPriceBreak object
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
Responses
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
DELETE /api/company/price-break/{id}/¶
Description
Detail endpoint for SupplierPriceBreak object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/price-break/{id}/¶
Description
Detail endpoint for SupplierPriceBreak object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
PATCH /api/company/price-break/{id}/¶
Description
Detail endpoint for SupplierPriceBreak object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
Responses
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
PUT /api/company/price-break/{id}/¶
Description
Detail endpoint for SupplierPriceBreak object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the request body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
Responses
{
"part": 0,
"part_detail": null,
"pk": 0,
"price": "string",
"price_currency": "string",
"quantity": 10.12,
"supplier": 0,
"supplier_detail": null,
"updated": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"description": "Serializer for SupplierPriceBreak object.\n\nNote that this inherits from the SupplierPriceBreakBriefSerializer,\nand does so to prevent circular serializer import issues.",
"properties": {
"part": {
"type": "integer"
},
"part_detail": {
"allOf": [
{
"$ref": "#/components/schemas/SupplierPart"
}
],
"nullable": true,
"readOnly": true
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"price": {
"format": "decimal",
"nullable": true,
"pattern": "^-?\\d{0,13}(?:\\.\\d{0,6})?$",
"type": "string"
},
"price_currency": {
"description": "Select currency from available options\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"title": "Currency",
"type": "string"
},
"quantity": {
"format": "double",
"type": "number"
},
"supplier": {
"readOnly": true,
"type": "integer"
},
"supplier_detail": {
"allOf": [
{
"$ref": "#/components/schemas/CompanyBrief"
}
],
"nullable": true,
"readOnly": true
},
"updated": {
"description": "Timestamp of last update",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"part",
"pk",
"price",
"quantity",
"supplier"
],
"type": "object"
}
DELETE /api/company/{id}/¶
Description
API endpoint for detail of a single Company object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
GET /api/company/{id}/¶
Description
API endpoint for detail of a single Company object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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 |
Responses
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 253,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the response body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
PATCH /api/company/{id}/¶
Description
API endpoint for detail of a single Company object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 274,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 284,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 227,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"type": "object"
}
Responses
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 29,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the response body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
PUT /api/company/{id}/¶
Description
API endpoint for detail of a single Company object.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
oauth2 |
header | string | N/A | No | |
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
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 233,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 250,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 291,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the request body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
Responses
{
"active": true,
"contact": "string",
"currency": "string",
"description": "string",
"email": "derp@meme.org",
"image": "string",
"is_customer": true,
"is_manufacturer": true,
"is_supplier": true,
"link": "string",
"name": "string",
"notes": "string",
"parameters": [
{
"data": "string",
"data_numeric": 10.12,
"model_id": 195,
"model_type": null,
"note": "string",
"pk": 0,
"template": 0,
"template_detail": null,
"updated": "2022-04-13T15:42:05.901Z",
"updated_by": 0,
"updated_by_detail": null
}
],
"parts_manufactured": 0,
"parts_supplied": 0,
"phone": "string",
"pk": 0,
"primary_address": null,
"remote_image": "string",
"tax_id": "string",
"website": "string"
}
Schema of the response body
{
"description": "Serializer for Company object (full detail).",
"properties": {
"active": {
"description": "Is this company active?",
"type": "boolean"
},
"contact": {
"description": "Point of contact",
"maxLength": 100,
"type": "string"
},
"currency": {
"description": "Default currency used for this supplier\n\n* `AUD` - AUD - Australian Dollar\n* `CAD` - CAD - Canadian Dollar\n* `CNY` - CNY - Chinese Yuan\n* `EUR` - EUR - Euro\n* `GBP` - GBP - British Pound\n* `JPY` - JPY - Japanese Yen\n* `NZD` - NZD - New Zealand Dollar\n* `USD` - USD - US Dollar\n\nOther valid currencies may be found in the 'CURRENCY_CODES' global setting.",
"type": "string"
},
"description": {
"description": "Description of the company",
"maxLength": 500,
"title": "Company description",
"type": "string"
},
"email": {
"default": "",
"format": "email",
"nullable": true,
"type": "string"
},
"image": {
"format": "uri",
"nullable": true,
"type": "string"
},
"is_customer": {
"description": "Do you sell items to this company?",
"type": "boolean"
},
"is_manufacturer": {
"description": "Does this company manufacture parts?",
"type": "boolean"
},
"is_supplier": {
"description": "Do you purchase items from this company?",
"type": "boolean"
},
"link": {
"description": "Link to external company information",
"format": "uri",
"maxLength": 2000,
"type": "string"
},
"name": {
"description": "Company name",
"maxLength": 100,
"title": "Company name",
"type": "string"
},
"notes": {
"description": "Markdown notes (optional)",
"maxLength": 50000,
"nullable": true,
"type": "string"
},
"parameters": {
"items": {
"$ref": "#/components/schemas/Parameter"
},
"nullable": true,
"readOnly": true,
"type": "array"
},
"parts_manufactured": {
"readOnly": true,
"type": "integer"
},
"parts_supplied": {
"readOnly": true,
"type": "integer"
},
"phone": {
"description": "Contact phone number",
"maxLength": 50,
"title": "Phone number",
"type": "string"
},
"pk": {
"readOnly": true,
"title": "ID",
"type": "integer"
},
"primary_address": {
"allOf": [
{
"$ref": "#/components/schemas/AddressBrief"
}
],
"nullable": true,
"readOnly": true
},
"remote_image": {
"description": "URL of remote image file",
"format": "uri",
"type": "string",
"writeOnly": true
},
"tax_id": {
"description": "Company Tax ID",
"maxLength": 50,
"type": "string"
},
"website": {
"description": "Company website URL",
"format": "uri",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"currency",
"name",
"parts_manufactured",
"parts_supplied",
"pk"
],
"type": "object"
}
Schemas¶
Address¶
| Name | Type | Description |
|---|---|---|
company |
integer | Select company |
country |
string | Address country |
internal_shipping_notes |
string | Shipping notes for internal use |
line1 |
string | Address line 1 |
line2 |
string | Address line 2 |
link |
string(uri) | Link to address information (external) |
pk |
integer | |
postal_city |
string | Postal code city/region |
postal_code |
string | Postal code |
primary |
boolean | Set as primary address |
province |
string | State or province |
shipping_notes |
string | Notes for shipping courier |
title |
string | Title describing the address entry |
AddressBrief¶
| Name | Type | Description |
|---|---|---|
country |
string | Address country |
internal_shipping_notes |
string | Shipping notes for internal use |
line1 |
string | Address line 1 |
line2 |
string | Address line 2 |
pk |
integer | |
postal_city |
string | Postal code city/region |
postal_code |
string | Postal code |
province |
string | State or province |
shipping_notes |
string | Notes for shipping courier |
BlankEnum¶
Type:
BulkRequest¶
| Name | Type | Description |
|---|---|---|
filters |
||
items |
Array<integer> |
Company¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this company active? |
contact |
string | Point of contact |
currency |
string | Default currency used for this supplier * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
description |
string | Description of the company |
email |
string(email) | null | |
image |
string(uri) | null | |
is_customer |
boolean | Do you sell items to this company? |
is_manufacturer |
boolean | Does this company manufacture parts? |
is_supplier |
boolean | Do you purchase items from this company? |
link |
string(uri) | Link to external company information |
name |
string | Company name |
notes |
string | null | Markdown notes (optional) |
parameters |
Array<Parameter> | |
parts_manufactured |
integer | |
parts_supplied |
integer | |
phone |
string | Contact phone number |
pk |
integer | |
primary_address |
||
remote_image |
string(uri) | URL of remote image file |
tax_id |
string | Company Tax ID |
website |
string(uri) | Company website URL |
CompanyBrief¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this company active? |
currency |
string | Default currency used for this company |
description |
string | Description of the company |
image |
string(uri) | |
name |
string | Company name |
pk |
integer | |
tax_id |
string | Company Tax ID |
thumbnail |
string |
Contact¶
| Name | Type | Description |
|---|---|---|
company |
integer | |
company_name |
string | |
email |
string(email) | |
name |
string | |
phone |
string | |
pk |
integer | |
role |
string |
ManufacturerPart¶
| Name | Type | Description |
|---|---|---|
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Manufacturer part description |
link |
string(uri) | null | URL for external manufacturer part link |
manufacturer |
integer | |
manufacturer_detail |
||
MPN |
string | null | Manufacturer Part Number |
notes |
string | null | Markdown notes (optional) |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
tags |
Array<string> |
ModelType054Enum¶
Type: string
NullEnum¶
Type:
PaginatedAddressList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Address> |
PaginatedCompanyList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Company> |
PaginatedContactList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<Contact> |
PaginatedManufacturerPartList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<ManufacturerPart> |
PaginatedSupplierPartList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<SupplierPart> |
PaginatedSupplierPriceBreakList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
next |
string(uri) | null | |
previous |
string(uri) | null | |
results |
Array<SupplierPriceBreak> |
Parameter¶
| Name | Type | Description |
|---|---|---|
data |
string | Parameter Value |
data_numeric |
number(double) | null | |
model_id |
integer(int64) | ID of the target model for this parameter |
model_type |
||
note |
string | Optional note field |
pk |
integer | |
template |
integer | Parameter template |
template_detail |
||
updated |
string(date-time) | null | Timestamp of last update |
updated_by |
integer | null | User who last updated this object |
updated_by_detail |
ParameterTemplate¶
| Name | Type | Description |
|---|---|---|
checkbox |
boolean | Is this parameter a checkbox? |
choices |
string | Valid choices for this parameter (comma-separated) |
description |
string | Parameter description |
enabled |
boolean | Is this parameter template enabled? |
model_type |
||
name |
string | Parameter Name |
pk |
integer | |
selectionlist |
integer | null | Selection list for this parameter |
units |
string | Physical units for this parameter |
PartBrief¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this part active? |
assembly |
boolean | Can this part be built from other parts? |
barcode_hash |
string | Unique hash of barcode data |
category_default_location |
integer | null | |
component |
boolean | Can this part be used to build other parts? |
default_expiry |
integer(int64) | Expiry time (in days) for stock items of this part |
default_location |
integer | null | Where is this item normally stored? |
description |
string | Part description (optional) |
full_name |
string | Format a 'full name' for this Part based on the format PART_NAME_FORMAT defined in InvenTree settings. |
image |
string(uri) | null | |
IPN |
string | null | Internal Part Number |
is_template |
boolean | Is this part a template part? |
locked |
boolean | Locked parts cannot be edited |
minimum_stock |
string(decimal) | Minimum allowed stock level |
name |
string | Part name |
pk |
integer | |
pricing_max |
string(decimal) | null | |
pricing_min |
string(decimal) | null | |
purchaseable |
boolean | Can this part be purchased from external suppliers? |
revision |
string | null | |
salable |
boolean | Can this part be sold to customers? |
testable |
boolean | Can this part have test results recorded against it? |
thumbnail |
string | |
trackable |
boolean | Does this part have tracking for unique items? |
units |
string | null | Units of measure for this part |
virtual |
boolean | Is this a virtual part, such as a software product or license? |
PatchedAddress¶
| Name | Type | Description |
|---|---|---|
company |
integer | Select company |
country |
string | Address country |
internal_shipping_notes |
string | Shipping notes for internal use |
line1 |
string | Address line 1 |
line2 |
string | Address line 2 |
link |
string(uri) | Link to address information (external) |
pk |
integer | |
postal_city |
string | Postal code city/region |
postal_code |
string | Postal code |
primary |
boolean | Set as primary address |
province |
string | State or province |
shipping_notes |
string | Notes for shipping courier |
title |
string | Title describing the address entry |
PatchedCompany¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this company active? |
contact |
string | Point of contact |
currency |
string | Default currency used for this supplier * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
description |
string | Description of the company |
email |
string(email) | null | |
image |
string(uri) | null | |
is_customer |
boolean | Do you sell items to this company? |
is_manufacturer |
boolean | Does this company manufacture parts? |
is_supplier |
boolean | Do you purchase items from this company? |
link |
string(uri) | Link to external company information |
name |
string | Company name |
notes |
string | null | Markdown notes (optional) |
parameters |
Array<Parameter> | |
parts_manufactured |
integer | |
parts_supplied |
integer | |
phone |
string | Contact phone number |
pk |
integer | |
primary_address |
||
remote_image |
string(uri) | URL of remote image file |
tax_id |
string | Company Tax ID |
website |
string(uri) | Company website URL |
PatchedContact¶
| Name | Type | Description |
|---|---|---|
company |
integer | |
company_name |
string | |
email |
string(email) | |
name |
string | |
phone |
string | |
pk |
integer | |
role |
string |
PatchedManufacturerPart¶
| Name | Type | Description |
|---|---|---|
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Manufacturer part description |
link |
string(uri) | null | URL for external manufacturer part link |
manufacturer |
integer | |
manufacturer_detail |
||
MPN |
string | null | Manufacturer Part Number |
notes |
string | null | Markdown notes (optional) |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
tags |
Array<string> |
PatchedSupplierPart¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this supplier part active? |
availability_updated |
string(date-time) | null | Date of last update of availability data |
available |
number(double) | |
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Supplier part description |
in_stock |
number(double) | null | |
link |
string(uri) | null | URL for external supplier part link |
manufacturer_detail |
||
manufacturer_part |
integer | null | Select manufacturer part |
manufacturer_part_detail |
||
MPN |
string | null | |
note |
string | null | Notes |
notes |
string | null | Markdown notes (optional) |
on_order |
number(double) | null | |
pack_quantity |
string | Total quantity supplied in a single pack. Leave empty for single items. |
pack_quantity_native |
number(double) | |
packaging |
string | null | Part packaging |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
price_breaks |
Array<SupplierPriceBreakBrief> | |
primary |
boolean | Is this the primary supplier part for the linked Part? |
SKU |
string | Supplier stock keeping unit |
supplier |
integer | |
supplier_detail |
||
tags |
Array<string> | |
updated |
string(date-time) | null |
PatchedSupplierPriceBreak¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
part_detail |
||
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) | |
supplier |
integer | |
supplier_detail |
||
updated |
string(date-time) | null | Timestamp of last update |
SupplierPart¶
| Name | Type | Description |
|---|---|---|
active |
boolean | Is this supplier part active? |
availability_updated |
string(date-time) | null | Date of last update of availability data |
available |
number(double) | |
barcode_hash |
string | Unique hash of barcode data |
description |
string | null | Supplier part description |
in_stock |
number(double) | null | |
link |
string(uri) | null | URL for external supplier part link |
manufacturer_detail |
||
manufacturer_part |
integer | null | Select manufacturer part |
manufacturer_part_detail |
||
MPN |
string | null | |
note |
string | null | Notes |
notes |
string | null | Markdown notes (optional) |
on_order |
number(double) | null | |
pack_quantity |
string | Total quantity supplied in a single pack. Leave empty for single items. |
pack_quantity_native |
number(double) | |
packaging |
string | null | Part packaging |
parameters |
Array<Parameter> | |
part |
integer | Select part |
part_detail |
||
pk |
integer | |
pretty_name |
string | null | |
price_breaks |
Array<SupplierPriceBreakBrief> | |
primary |
boolean | Is this the primary supplier part for the linked Part? |
SKU |
string | Supplier stock keeping unit |
supplier |
integer | |
supplier_detail |
||
tags |
Array<string> | |
updated |
string(date-time) | null |
SupplierPriceBreak¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
part_detail |
||
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) | |
supplier |
integer | |
supplier_detail |
||
updated |
string(date-time) | null | Timestamp of last update |
SupplierPriceBreakBrief¶
| Name | Type | Description |
|---|---|---|
part |
integer | |
pk |
integer | |
price |
string(decimal) | null | |
price_currency |
string | Select currency from available options * `AUD` - AUD - Australian Dollar * `CAD` - CAD - Canadian Dollar * `CNY` - CNY - Chinese Yuan * `EUR` - EUR - Euro * `GBP` - GBP - British Pound * `JPY` - JPY - Japanese Yen * `NZD` - NZD - New Zealand Dollar * `USD` - USD - US Dollar Other valid currencies may be found in the 'CURRENCY_CODES' global setting. |
quantity |
number(double) | |
supplier |
integer | |
updated |
string(date-time) | null | Timestamp of last update |
User¶
| Name | Type | Description |
|---|---|---|
email |
string(email) | Email address of the user |
first_name |
string | First name of the user |
last_name |
string | Last name of the user |
pk |
integer | |
username |
string | Username |
Common responses¶
This section describes common responses that are reused across operations.
allauth.AddAuthenticatorConflict¶
The account prohibits adding an authenticator, e.g. because of an unverified email address.
Schema of the response body
null
allauth.AddWebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.\n",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data",
"meta"
],
"type": "object"
}
allauth.Authenticated¶
The user is authenticated.
Schema of the response body
null
allauth.AuthenticatedByCode¶
Authenticated by code.
{
"summary": "Authenticated by code.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "code"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPassword¶
Authenticated by password.
{
"summary": "Authenticated by password.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.AuthenticatedByPasswordAnd2FA¶
Authenticated by password and 2FA.
{
"summary": "Fully authenticated using by password and 2FA.\n",
"value": {
"data": {
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW",
"is_authenticated": true,
"session_token": "ufwcig0zen9skyd545jc0fkq813ghar2"
},
"status": 200
}
}
Schema of the response body
null
allauth.Authentication¶
Not authenticated.
{
"summary": "Reauthentication required\n",
"value": {
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
}
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending 2FA\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "mfa_authenticate",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending email verification\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "verify_email",
"is_pending": true
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
{
"summary": "Unauthenticated: pending provider signup\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
},
{
"id": "provider_signup",
"is_pending": true,
"provider": {
"client_id": "123.apps.googleusercontent.com",
"flows": [
"provider_redirect",
"provider_token"
],
"id": "google",
"name": "Google"
}
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.AuthenticationOrReauthentication¶
The response indicates authentication or re-authentication is required.
Schema of the response body
{
"oneOf": [
{
"$ref": "#/components/schemas/allauth.AuthenticationResponse"
},
{
"$ref": "#/components/schemas/allauth.ReauthenticationResponse"
}
]
}
allauth.Authenticators¶
List of authenticators.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.AuthenticatorList"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.Configuration¶
The django-allauth configuration.
Schema of the response body
null
allauth.EmailAddresses¶
List of email addresses.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.EmailVerificationInfo¶
Email verification information.
Schema of the response body
null
allauth.Error¶
An input error occurred.
Schema of the response body
null
allauth.Forbidden¶
A forbidden response.
Schema of the response body
null
allauth.NotFound¶
Not found.
{
"status": 404
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.PasswordResetInfo¶
Information about the password reset key.
{
"data": {
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.PhoneNumbers¶
List of phone numbers.
Schema of the response body
null
allauth.ProviderAccounts¶
List of third-party provider accounts.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ProviderSignup¶
Information relating to the pending provider signup.
{
"data": {
"account": null,
"email": [
null
],
"user": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"account": {
"$ref": "#/components/schemas/allauth.ProviderAccount"
},
"email": {
"items": {
"$ref": "#/components/schemas/allauth.EmailAddress"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/allauth.User"
}
},
"required": [
"email",
"account",
"user"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.ReauthenticationRequired¶
The response indicates reauthentication is required.
{
"data": {
"flows": [
{
"id": "reauthenticate"
},
{
"id": "mfa_reauthenticate"
}
],
"methods": [
{
"at": 1711555057.065702,
"email": "email@domain.org",
"method": "password"
},
{
"at": 1711555060.9375854,
"id": 66,
"method": "mfa",
"type": "totp"
}
],
"user": {
"display": "Magic Wizard",
"email": "email@domain.org",
"has_usable_password": true,
"id": 123,
"username": "wizard"
}
},
"meta": {
"is_authenticated": true
},
"status": 401
}
Schema of the response body
null
allauth.RecoveryCodes¶
Information on the recovery codes.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.SensitiveRecoveryCodesAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.RefreshToken¶
A new access token (and optionally new refresh token).
{
"data": {
"access_token": null,
"refresh_token": null
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"properties": {
"access_token": {
"$ref": "#/components/schemas/allauth.AccessToken"
},
"refresh_token": {
"$ref": "#/components/schemas/allauth.RefreshToken"
}
},
"required": [
"access_token"
],
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"data",
"status"
],
"type": "object"
}
allauth.SessionGone¶
The response indicates session is invalid or no longer exists.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.Sessions¶
List of sessions.
{
"data": [
null
],
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/allauth.Session"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.StatusOK¶
A success response.
{
"status": null
}
Schema of the response body
{
"properties": {
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.TOTPAuthenticator¶
Information on the TOTP authenticator.
{
"data": null,
"meta": {
"recovery_codes_generated": true
},
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.TOTPAuthenticator"
},
"meta": {
"properties": {
"recovery_codes_generated": {
"description": "Whether or not recovery codes where generated automatically.",
"type": "boolean"
}
},
"type": "object"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.TOTPAuthenticatorNotFound¶
No TOTP authenticator has been set up.
{
"meta": {
"secret": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"totp_url": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example"
},
"status": 404
}
Schema of the response body
{
"properties": {
"meta": {
"properties": {
"secret": {
"description": "A TOTP secret that can be used to setup a new authenticator.\n",
"example": "J4ZKKXTK7NOVU7EPUVY23LCDV4T2QZYM",
"type": "string"
},
"totp_url": {
"description": "otpauth URI from which a QR code can be generated and scanned by OTP clients.\n",
"example": "otpauth://totp/Example:alice@fsf.org?secret=JBSWY3DPEHPK3PXP&issuer=Example",
"type": "string"
}
},
"required": [
"secret",
"totp_url"
],
"type": "object"
},
"status": {
"enum": [
404
],
"type": "integer"
}
},
"required": [
"status",
"meta"
],
"type": "object"
}
allauth.TooManyRequests¶
Too many requests.
{
"status": 429
}
Schema of the response body
{
"properties": {
"status": {
"enum": [
429
],
"type": "integer"
}
},
"required": [
"status"
],
"type": "object"
}
allauth.Unauthenticated¶
There is no authenticated session.
{
"summary": "Unauthenticated: Initial\n",
"value": {
"data": {
"flows": [
{
"id": "login"
},
{
"id": "signup"
},
{
"id": "provider_redirect",
"providers": [
"facebook",
"google",
"telegram"
]
},
{
"id": "provider_token",
"providers": [
"google"
]
}
]
},
"meta": {
"is_authenticated": false
},
"status": 401
}
}
Schema of the response body
null
allauth.WebAuthnAuthenticator¶
A WebAuthn authenticator.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnAuthenticator"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnCreationOptionsResponse¶
WebAuthn credential creation options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialCreationOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
allauth.WebAuthnRequestOptionsResponse¶
WebAuthn credential request options.
{
"data": null,
"status": null
}
Schema of the response body
{
"properties": {
"data": {
"$ref": "#/components/schemas/allauth.WebAuthnCredentialRequestOptions"
},
"status": {
"$ref": "#/components/schemas/allauth.StatusOK"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
Common parameters¶
This section describes common parameters that are reused across operations.
allauth.EmailVerificationKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Email-Verification-Key |
header | string | No |
allauth.PasswordLess¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
passwordless |
query | boolean | No |
allauth.PasswordResetKey¶
| Name | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
X-Password-Reset-Key |
header | string | No |
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| basicAuth | http | basic | |
| cookieAuth | apiKey | ||
| oauth2 | oauth2 | ||
| 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