Production item tags

Add Tags to a Specific Production Item

post

This method allows you to add tags to a specific production item (line item) in an order. Optionally, you can choose to apply the tags to nested (child) production items as well.

Notes

  • If all parameters are passed correctly, the system adds the specified tags to the selected production item (line item) and all its nested production items (child productions), if they exist, provided that the apply_to_nested_productions parameter is set to true.

  • If the `apply_to_nested_productions parameter is not provided, the system adds the tags only to the main production item (line item), and the nested production items (child productions) remain unchanged.

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
line_item_idstringRequired

The unique identifier of the production item

Example: 557657-8654-89i76
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
tagsstring[]Required

A list of tags to be added to the production item

Example: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptional

Determines if the tags should be applied to nested (child) production items. "true" — Tags are inherited by nested productions. "false" — Tags are not inherited by nested productions. Default option: "false" if not specified.

Example: false
Responses
201Success
application/json
post
/api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags
POST /api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "tags": [
    "Rush order",
    "High priority"
  ],
  "apply_to_nested_productions": false
}
201Success
{
  "message": "The operation was done successfully"
}

Replace tags for a specific production item

put

This method allows to replaces existing tags with the specified list of new tags for a specific line item (production). Optionally, it can also replace tags for all nested (child) productions if specified.

Notes

  • If all parameters are passed correctly, the system replaces the tags that were passed in this request for the line items (productions), which IDs were passed in the request with replacing tags of the subitems (child productions) if the specified line items (productions) have any.

  • If the apply_to_nested_productions parameter is not provided, the system replaces the tags that were passed in this request for the line items (productions), which IDs were passed in the request without replacing tags of the subitems (child productions) if the specified line items (productions) have any.

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
line_item_idstringRequired

The unique identifier of the production item

Example: 557657-8654-89i76
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
tagsstring[]Required

A list of tags to be added to the production item

Example: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptional

Determines if the tags should be applied to nested (child) production items. "true" — Tags are inherited by nested productions. "false" — Tags are not inherited by nested productions. Default option: "false" if not specified.

Example: false
Responses
200Success
application/json
put
/api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags
PUT /api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "tags": [
    "Rush order",
    "High priority"
  ],
  "apply_to_nested_productions": false
}
200Success
{
  "message": "The operation was done successfully"
}

Delete tags for a specific production item

delete

This method allows to delete existing tags with the specified list of new tags for a specific line item (production). Optionally, it can also delete tags for all nested (child) productions if specified.

Notes

  • If all parameters are passed correctly, the system deletes the tags that were passed in this request for the line items (productions), which IDs were passed in the request with deleting tags of the subitems (child productions) if the specified line items (productions) have any.

  • If the apply_to_nested_productions parameter is not provided, the system deletes the tags that were passed in this request for the line items (productions), which IDs were passed in the request without deleting tags of the subitems (child productions) if the specified line items (productions) have any.

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
line_item_idstringRequired

The unique identifier of the production item

Example: 557657-8654-89i76
Query parameters
tagsstringRequiredExample: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptionalExample: false
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Responses
200Success
application/json
delete
/api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags
DELETE /api/v1/public/orders/{external_order_id}/line-items/{line_item_id}/tags?tags=text HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
200Success
{
  "message": "The operation was done successfully"
}

Add Tags to All Productions Associated with the Order

post

Adds specified tags to all productions (line items) linked to a given order. Optionally, it can also add these tags to all nested (child) productions if specified.

Notes

  • If all parameters are passed correctly, The system adds the tags that were passed in this request to all line items (productions), connected with the order, which ID was passed in the request, with adding the subitems (child productions).

  • If the apply_to_nested_productions parameter is not provided, the system adds the tags that were passed in this request to all line items (productions), connected with the order, which ID was passed in the request, without adding the subitems (child productions) if the line items (productions) have any.

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
tagsstring[]Required

A list of tags to be added to the production item

Example: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptional

Determines if the tags should be applied to nested (child) production items. "true" — Tags are inherited by nested productions. "false" — Tags are not inherited by nested productions. Default option: "false" if not specified.

Example: false
Responses
201Success
application/json
post
/api/v1/public/orders/{external_order_id}/tags
POST /api/v1/public/orders/{external_order_id}/tags HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "tags": [
    "Rush order",
    "High priority"
  ],
  "apply_to_nested_productions": false
}
201Success
{
  "message": "The operation was done successfully"
}

Replace tags for all productions associated with the order

put

This method allows to replaces existing tags with the specified list of new tags for all productions in this order. Optionally, it can also replace tags for all nested (child) productions if specified.

Notes

  • If all parameters are passed correctly, the system replaces the tags that were passed in this request for the all line items (productions), which IDs were passed in the request with replacing tags of the subitems (child productions) if the specified line items (productions) have any.

  • If the apply_to_nested_productions parameter is not provided, the system replaces the tags that were passed in this request for the all line items (productions), which IDs were passed in the request without replacing tags of the subitems (child productions) if the specified line items (productions) have any.

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Body
tagsstring[]Required

A list of tags to be added to the production item

Example: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptional

Determines if the tags should be applied to nested (child) production items. "true" — Tags are inherited by nested productions. "false" — Tags are not inherited by nested productions. Default option: "false" if not specified.

Example: false
Responses
200Success
application/json
put
/api/v1/public/orders/{external_order_id}/tags
PUT /api/v1/public/orders/{external_order_id}/tags HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "tags": [
    "Rush order",
    "High priority"
  ],
  "apply_to_nested_productions": false
}
200Success
{
  "message": "The operation was done successfully"
}

Delete tags for all productions associated with the order

delete

This method allows to delete existing tags with the specified list of new tags for all productions in this order. Optionally, it can also delete tags for all nested (child) productions if specified.

Notes

  • If all parameters are passed correctly, the system deletes the tags that were passed in this request for the all line items (productions), which IDs were passed in the request with deleting tags of the subitems (child productions).

  • If the apply_to_nested_productions parameter is not provided, the system deletes the tags that were passed in this request for the all line items (productions), which IDs were passed in the request without deleting tags of the subitems (child productions).

  • If at least one parameter is missing or incorrect, the system returns a 400 Bad Request error, indicating incomplete or invalid data in the request.

Authorizations
Path parameters
external_order_idstringRequired

The unique identifier of the order

Example: b86fa12a-76fc-46f5-8a3e-bf39e7be4c4e
Query parameters
tagsstringRequiredExample: ["Rush order","High priority"]
apply_to_nested_productionsbooleanOptionalExample: false
Header parameters
x-tenant-idstring · uuidRequired

Tenant id (uuid v4)

Responses
200Success
application/json
delete
/api/v1/public/orders/{external_order_id}/tags
DELETE /api/v1/public/orders/{external_order_id}/tags?tags=text HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
x-tenant-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*
200Success
{
  "message": "The operation was done successfully"
}
PreviousClientsNextRewards

Last updated