Stock Adjustment Documents

Download schema

Stock Adjustments API.

Stock Adjustments are used to adjust stock levels.

There are two types of stock adjustments:

Single Adjustment to adjust the stock of a single product at a particular warehouse.
Stock Adjustment Document to adjust the stock of multiple products at the same warehouse.

List Stock Adjustment Documents

GET

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/

Authorization (header)

Stock adjustment documents are used to adjust the stock levels in bulk. You can add multiple product in the document and based on the adjustment_type the stock levels will be adjusted. The mark complete action is async. You will get the task status using the field is_task_in_progress.

List Stock Adjustment Documents › query Parameters

adjustment_type

string

created_range_after

string · date-time

Created at

created_range_before

string · date-time

Created at

is_complete

boolean

is_task_in_progress

boolean

limit

integer

Number of results to return per page.

notes

string

number

string

o

string[] · style: form

Ordering

id - Id
-id - Id (descending)
updated - Updated
-updated - Updated (descending)

Enum values:

-id

-updated

updated

offset

integer

The initial index from which to return the results.

ordering

string

Which field to use when ordering the results.

reason

string

updated_range_after

string · date-time

Updated at

updated_range_before

string · date-time

Updated at

warehouse

number

List Stock Adjustment Documents › Responses

200

PaginatedStockAdjustmentDocumentList

count

integer · required

StockAdjustmentDocument[] · required

next

string | null · uri

previous

string | null · uri

GET/stock/adjustment/documents/

curl https://inventory-api.sumtracker.com/api/version/2025-03/stock/adjustment/documents \
  --header 'Authorization: <api-key>'

Example Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": 0,
      "created": "2024-08-25T15:00:00Z",
      "updated": "2024-08-25T15:00:00Z",
      "number": "number",
      "is_task_in_progress": true,
      "action_performed": "action_performed",
      "notes": "notes",
      "total_quantity": 0,
      "adjustment_type": "SET",
      "reason": "reason",
      "warehouse_id": 0,
      "is_complete": true
    }
  ]
}

json

application/json

Create Stock Adjustment Document

POST

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/

Authorization (header)

API endpoint to create and list adjustment documents.

Create Stock Adjustment Document › Request Body

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocument

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · enum · required

Can be either one of: SET, ADD, SUB

SET - SET
ADD - ADD
SUB - SUB

Enum values:

SET

ADD

SUB

reason

string · maxLength: 1024 · required

warehouse_id

integer · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

Create Stock Adjustment Document › Responses

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocument

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · enum · required

Can be either one of: SET, ADD, SUB

SET - SET
ADD - ADD
SUB - SUB

Enum values:

SET

ADD

SUB

reason

string · maxLength: 1024 · required

warehouse_id

integer · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

POST/stock/adjustment/documents/

curl https://inventory-api.sumtracker.com/api/version/2025-03/stock/adjustment/documents \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "SET",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}'

Example Request Body

{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "SET",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}

json

Example Responses

{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "SET",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}

json

application/json

Get Stock Adjustment Document

GET

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/{id}/

Authorization (header)

Get the details of a single adjustment document.

Get Stock Adjustment Document › path Parameters

id

integer · required

Get Stock Adjustment Document › Responses

200

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocumentUpdate

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · readOnly · required

reason

string · readOnly · required

warehouse_id

integer · readOnly · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

Update Stock Adjustment Document

PUT

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/{id}/

Authorization (header)

Update the adjustment document.

Update Stock Adjustment Document › path Parameters

id

integer · required

Update Stock Adjustment Document › Request Body

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocumentUpdate

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · readOnly · required

reason

string · readOnly · required

warehouse_id

integer · readOnly · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

Update Stock Adjustment Document › Responses

200

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocumentUpdate

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · readOnly · required

reason

string · readOnly · required

warehouse_id

integer · readOnly · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

PUT/stock/adjustment/documents/{id}/

curl https://inventory-api.sumtracker.com/api/version/2025-03/stock/adjustment/documents/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: <api-key>' \
  --data '{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "adjustment_type",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}'

Example Request Body

{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "adjustment_type",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}

json

Example Responses

{
  "id": 0,
  "created": "2024-08-25T15:00:00Z",
  "updated": "2024-08-25T15:00:00Z",
  "number": "number",
  "is_task_in_progress": true,
  "action_performed": "action_performed",
  "notes": "notes",
  "total_quantity": 0,
  "adjustment_type": "adjustment_type",
  "reason": "reason",
  "warehouse_id": 0,
  "is_complete": true
}

json

application/json

Delete Stock Adjustment Document

DELETE

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/{id}/

Authorization (header)

Deletes the adjustment document. Only documents with is_complete as False can be deleted.

Delete Stock Adjustment Document › path Parameters

id

integer · required

Delete Stock Adjustment Document › Responses

No response body

No data returned

Mark Complete

PUT

https://inventory-api.sumtracker.com/api/version/2025-03

/stock/adjustment/documents/perform_action/{id}/mark-complete/

Authorization (header)

Mark the stock adjustment document as complete. This will adjust the stock levels of all the products in the document. When you send the request to mark the document as complete, the field is_task_in_progress becomes true which means the background task has started now. When the field becomes false it means the task has finished and the document is now complete.

Mark Complete › path Parameters

id

integer · required

Mark Complete › Responses

200

StockAdjustmentDocument Serializer mixin

StockAdjustmentDocument

id

integer · readOnly · required

created

string · date-time · readOnly · required

updated

string · date-time · readOnly · required

number

string · readOnly · required

is_task_in_progress

boolean · readOnly · required

Is any background task in progress. For example mark as complete task.

action_performed

string · readOnly · required

The action performed on the document which initiated the task.

total_quantity

integer · readOnly · required

Total sum of quantities from all associated lines within the document.

adjustment_type

string · enum · required

Can be either one of: SET, ADD, SUB

SET - SET
ADD - ADD
SUB - SUB

Enum values:

SET

ADD

SUB

reason

string · maxLength: 1024 · required

warehouse_id

integer · required

is_complete

boolean · readOnly · required

The status of the Adjust Stock Document. If false it means the document is still a draft and has no effect on the inventory.

notes

string

Receive Notes/Lines Stock Adjustment Documents/Lines