Sharetribe icon

Sharetribe

Allows interaction with the Sharetribe Integration API

Stock → Get Stock Adjustments

AI-generated

Summary

Retrieve stock adjustments for a given listing within a specified date range.

Inputs

  • listingId (required) — The ID of the listing
  • returnAll — Whether to return all results or only up to a given limit
  • countOnly — Whether to return only the count of matching stock adjustments
  • limit — Max number of results to return
  • simplify — Whether to return a simplified version of the response
  • stockFields — Choose from the list, or specify IDs using an expression.
  • listingFields — Choose from the list, or specify IDs using an expression.
  • transactionFields — Choose from the list, or specify IDs using an expression.
  • userFields — Which listing author fields to return. Choose from the list, or specify IDs using an expression.
  • userFields — Which customer/provider fields to return. Choose from the list, or specify IDs using an expression.
  • userFields — Which author/customer/provider fields to return. Choose from the list, or specify IDs using an expression.
  • createdAtStart (required) — Start time for the query range. Start time for the query range. Learn more.
  • createdAtEnd (required) — End time for the query range. End time for the query range. Learn more.

Output shape

Array of stock adjustment objects

If simplify is false the full response is returned; if countOnly is true only the count is returned; pagination via limit; optional fields can be selected via stockFields, listingFields, transactionFields, and userFields.

Examples

Example 1: Fetch recent adjustments for a specific listing

listingId = '550e8400-e29b-41d4-a716-446655440000', createdAtStart = '2023-01-01T00:00:00Z', createdAtEnd = '2023-12-31T23:59:59Z', limit = 10

Example 2: Return only the count of matching adjustments

countOnly = true

Example 3: Get all adjustments with full detail

returnAll = true, simplify = false

Links

Discussion