Get Bag Adjustment by ID

Retrieve a specific adjustment for a bag given an order_id, bag_id, and adjustment_id.

Only apps that created the bag (matching app_id) can access its adjustments.

Get Bag Adjustment by ID

get

Retrieves a specific adjustment for a bag. Only apps that created the bag (matching app_id) can access its adjustments.

Path parameters

order_idinteger · int64Required

bag_idinteger · int64Required

adjustment_idinteger · int64Required

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Responses

200

success

application/json

Financial adjustment to a Bag's totals

idinteger · int64Read-onlyOptional

Unique ID of the BagAdjustment.

bag_idinteger · int64Required

ID of the Bag this adjustment applies to.

order_idinteger · int64Required

ID of the parent Order (denormalized for convenience).

merchant_idinteger · int32Required

ID of the merchant this adjustment applies to.

app_idinteger · int32Required

ID of the App responsible for this Bag.

entity_typestring · enumRequired

Type of field being adjusted: SHIPPING_TOTAL, TAX_TOTAL, or DISCOUNT_TOTAL.

Possible values:

previous_valueinteger · int32Required

Original incorrect value in cents.

adjusted_valueinteger · int32Required

Corrected value in cents.

adjustment_deltainteger · int32Read-onlyOptional

Calculated difference (adjusted_value - previous_value) in cents.

shopper_adjustmentbooleanRequired

Whether this adjustment impacts the shopper.

shopper_adjustment_amountinteger · int32Required

Amount of impact on shopper in cents (negative = refund owed to shopper).

merchant_adjustmentbooleanRequired

Whether this adjustment impacts the merchant.

merchant_adjustment_amountinteger · int32Required

Amount of impact on merchant in cents (positive = merchant owed more, negative = merchant owed less).

channel_adjustmentbooleanRequired

Whether this adjustment impacts the channel.

channel_adjustment_amountinteger · int32Required

Amount of impact on channel in cents (typically opposite of merchant + shopper).

reasonstringRequired

Freeform text reason for the adjustment.

date_createdstring · date-time · max: 24Read-onlyOptional

Date the adjustment was created (immutable).

404

Order, bag, or adjustment not found

application/json

get

/orders/{order_id}/bags/{bag_id}/adjustments/{adjustment_id}

HTTPcURLJavaScriptPython

GET /v1/orders/{order_id}/bags/{bag_id}/adjustments/{adjustment_id} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Accept: */*

{
  "id": 10002,
  "bag_id": 22222,
  "order_id": 11111,
  "merchant_id": 10000,
  "app_id": 10193,
  "entity_type": "TAX_TOTAL",
  "previous_value": 850,
  "adjusted_value": 1050,
  "adjustment_delta": 200,
  "shopper_adjustment": true,
  "shopper_adjustment_amount": 200,
  "merchant_adjustment": true,
  "merchant_adjustment_amount": -200,
  "channel_adjustment": false,
  "channel_adjustment_amount": 0,
  "reason": "Tax was miscalculated for customer's jurisdiction",
  "data": {
    "notes": "Customer notified of additional charge",
    "adjusted_by": "[email protected]",
    "ticket_id": "TICKET-12345",
    "original_tax_rate": "8.5%",
    "corrected_tax_rate": "10.5%"
  },
  "date_created": "2024-12-08T15:30:00+0000"
}