SalesChannelProductStock

Retrieves all of inserted extra product stocks from related channel

get

Retrieves all of inserted extra product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/extra_product_stocks/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

Retrieves all of inserted extra product stocks from related channel

get

Retrieves all of inserted extra product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/extra_product_stocks/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

Retrieves all of inserted product stocks from related channel

get

Retrieves all of inserted product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

Retrieves all of inserted product stocks from related channel

get

Retrieves all of inserted product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

List all of product stocks from related channel

get

Lists all of product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

product__attributesstringOptional

Filter by attributes in JSON format.

Example: attributes__color=red

product__localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

productinteger · int64Optional

Filter by Product ID.

Example: 123

modifier_collectionstringOptional

Filter by modifier collection id

stockintegerOptional

Filter by product's stock value

unit_typestring · enumOptional

Filter by product's unit type value

Possible values:

sold_quantity_unreportedintegerOptional

Filter by product's sold quantity unreported value

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

stock_listarrayOptional

Filter by product's stock_list data

Responses

200

OK

application/json

401

Unauthorized Access

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "product": 1,
      "unit_type": "qty",
      "stock": 1,
      "sold_quantity_unreported": 1,
      "extra_field": {},
      "stock_list": 1,
      "modified_collection": 1,
      "adjusted_stock": 1,
      "created_date": "2025-05-22T10:52:12.762Z",
      "modified_date": "2025-05-22T10:52:12.762Z"
    }
  ]
}

List all of product stocks from related channel

get

Lists all of product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

product__attributesstringOptional

Filter by attributes in JSON format.

Example: attributes__color=red

product__localized_attributesstringOptional

Filter by localized attributes in JSON format.

Example: localized_attributes__locale=en-US

productinteger · int64Optional

Filter by Product ID.

Example: 123

modifier_collectionstringOptional

Filter by modifier collection id

stockintegerOptional

Filter by product's stock value

unit_typestring · enumOptional

Filter by product's unit type value

Possible values:

sold_quantity_unreportedintegerOptional

Filter by product's sold quantity unreported value

pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

stock_listarrayOptional

Filter by product's stock_list data

Responses

200

OK

application/json

401

Unauthorized Access

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "product": 1,
      "unit_type": "qty",
      "stock": 1,
      "sold_quantity_unreported": 1,
      "extra_field": {},
      "stock_list": 1,
      "modified_collection": 1,
      "adjusted_stock": 1,
      "created_date": "2025-05-22T10:52:12.762Z",
      "modified_date": "2025-05-22T10:52:12.762Z"
    }
  ]
}

List all of inserted product stocks from related channel

get

Lists all of inserted product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/inserts/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

List all of updated product stocks from related channel

get

Lists all of updated product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]

List all of inserted or updated product stocks from related channel

get

Lists all of inserted or updated product stocks data from related channel

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/product_stocks/inserts_or_updates/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "pk": 1,
    "product": 1,
    "unit_type": "qty",
    "stock": 1,
    "sold_quantity_unreported": 1,
    "extra_field": {},
    "stock_list": 1,
    "modified_collection": 1,
    "adjusted_stock": 1,
    "created_date": "2025-05-22T10:52:12.762Z",
    "modified_date": "2025-05-22T10:52:12.762Z"
  }
]