Sumtracker
Sumtracker Public API v2025-03
Sumtracker Public API v2025-03

Stock Adjustment Documents/Lines

Download schema

Stock Adjustment Document Line Items API.

List Lines

GET
https://inventory-api.sumtracker.com/api/version/2025-03
/stock/adjustment/documents/{document_id}/lines/
Authorization (header)

List of adjustment lines for a given adjustment document.

List Lines › path Parameters

document_id
​integer · required

List Lines › query Parameters

limit
​integer

Number of results to return per page.

o
​string[] · style: form

Ordering

  • id - Id
  • -id - Id (descending)
Enum values:
-id
id
offset
​integer

The initial index from which to return the results.

ordering
​string

Which field to use when ordering the results.

product
​number
quantity__isnull
​boolean

List Lines › Responses

200
PaginatedStockAdjustmentDocumentLineList
count
​integer · required
​StockAdjustmentDocumentLine[] · required
next
​string | null · uri
previous
​string | null · uri

Create Line

POST
https://inventory-api.sumtracker.com/api/version/2025-03
/stock/adjustment/documents/{document_id}/lines/
Authorization (header)

Create a new adjustment line item.

Create Line › path Parameters

document_id
​integer · required

Create Line › Request Body

Mixin to inherit for stock adjustment document line serializers for update and create.
StockAdjustmentDocumentLine
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Create Line › Responses

Mixin to inherit for stock adjustment document line serializers for update and create.
StockAdjustmentDocumentLine
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Update Line

PUT
https://inventory-api.sumtracker.com/api/version/2025-03
/stock/adjustment/documents/{document_id}/lines/{id}/
Authorization (header)

Update the quantity of a product in the adjustment line item.

Update Line › path Parameters

document_id
​integer · required
id
​integer · required

Update Line › Request Body

Adjust Stock Line Serializer used in Update case.
StockAdjustmentDocumentLineUpdate
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Update Line › Responses

200
Adjust Stock Line Serializer used in Update case.
StockAdjustmentDocumentLineUpdate
id
​integer · readOnly · required
created
​string · date-time · readOnly · required
product_id
​integer · readOnly · required
​object · readOnly · required

Product object.

quantity
​integer · required

If the adjustment type of the document is "ADD" or "SUB" then the quantity should not be 0. A negative quantity is allowed for "ADD", where it decreases the stock. For "SUB" the quantity is subtracted from the stock, so it must be positive. A validation error is raised otherwise.

adjustment_type
​string · enum · readOnly · required

Can be either one of: SET, ADD, SUB

  • SET - SET
  • ADD - ADD
  • SUB - SUB
Enum values:
SET
ADD
SUB
warehouse_id
​integer · readOnly · required
reason
​string · readOnly · required
document_id
​integer · readOnly · required
is_complete
​boolean · readOnly · required
cost
​string | null · decimal · pattern: ^-?\d{0,10}(?:\.\d{0…

Delete Line

DELETE
https://inventory-api.sumtracker.com/api/version/2025-03
/stock/adjustment/documents/{document_id}/lines/{id}/
Authorization (header)

Delete the adjustment line item.

Delete Line › path Parameters

document_id
​integer · required
id
​integer · required

Delete Line › Responses

No response body

No data returned
Stock Adjustment DocumentsStock