Skip to main content

OrderAdjustment

type OrderAdjustment {
amount: Float!
amountType: OrderAmountTypeEnum!
appliedOrderLines: [OrderAdjustmentAppliedOrderLine!]
campaignId: String
campaignType: CampaignTypeEnum
couponId: String
name: String!
order: Float!
transactionId: String
type: OrderAdjustmentEnum!
}

Fields

amountFloat!required

It is the adjustment amount in the order. This amount can be positive or negative.

amountTypeOrderAmountTypeEnum!required

A list of order line items, each containing information about a order line item in the order.

campaignIdString

If the adjustment is associated to the campaign, it will show the campaign id.

campaignTypeCampaignTypeEnum

If the adjustment is associated to the campaign, it will show the campaign id.

couponIdString

It is the coupon id generated depending on the campaign.

nameString!required

It is the name of the adjustment.

orderFloat!required

It is the order of the adjustment. Adjustments are applied in this order.

transactionIdString

The amount is the id of the transaction.