GET /adjustments/{id}.json

GET /adjustments/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • adjustmentReasonId integer(int32) | null

      Adjustment reason

    • automatedImport boolean | null Required

      Automated import

      Default value is false.

    • costPrice number | null Required

      Cost price

      Default value is 0.

    • createdAt string(date-time)

      Created at

    • dataImportId integer(int32) | null

      Data import

    • id integer(int32)

      Id

    • notes string | null

      Notes

    • quantity integer(int32) Required

      Quantity

    • stockTakeItemId integer(int32) | null

      Stock take item

    • updatedAt string(date-time)

      Updated at

    • userId integer(int32) | null

      User

    • variantId integer(int32) Required

      Variant

    • warehouseId integer(int32) Required

      Warehouse

    • xeroId string | null

      Xero

GET /adjustments/{id}.json
curl \
 --request GET 'http://api.example.com/v1/adjustments/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "adjustmentReasonId": 42,
  "automatedImport": false,
  "costPrice": 0,
  "createdAt": "2025-05-04T09:42:00Z",
  "dataImportId": 42,
  "id": 42,
  "notes": "string",
  "quantity": 42,
  "stockTakeItemId": 42,
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "variantId": 42,
  "warehouseId": 42,
  "xeroId": "string"
}