> ## Documentation Index > Fetch the complete documentation index at: https://docs.bilt.dev/llms.txt > Use this file to discover all available pages before exploring further. # Report an order event > Send Bilt one change to one order of a linked customer. Sign every request. See [Send order events](/partners/order-reporting/send-order-events.md) and [Sign your requests](/partners/order-reporting/sign-your-requests.md). ## OpenAPI ````yaml /partners/openapi.yaml post /v1/partners/order-reports openapi: 3.1.0 info: title: Bilt partner API version: 1.0.0 license: name: Proprietary identifier: LicenseRef-Proprietary description: > Link a Bilt member to an account in your product, and report that member's orders so Bilt can reward them. The `paths` are the endpoints Bilt hosts. The `webhooks` are the endpoints you host so Bilt can link, create, and unlink an account from the Bilt app. contact: name: Bilt partner support url: https://docs.bilt.dev/partners/overview servers: - url: https://partnerapi.biltrewards.com description: Production - url: https://staging.partnerapi.biltrewards.com description: Staging security: - partnerBearer: [] - apiKey: [] tags: - name: Endpoints you host description: > Endpoints you build and host. Bilt calls them from its backend when a member links, creates, or unlinks an account from the Bilt app. Base URLs are agreed during onboarding. - name: Account links description: > Endpoints Bilt hosts. You call them from your backend to create, read, and end a link. - name: Order reports description: > Endpoints Bilt hosts on its webhooks host. You post each change to a linked customer's order, signed with your Ed25519 key. This contract is a proposal under design review and is not live yet. paths: /v1/partners/order-reports: post: tags: - Order reports summary: Report an order event description: >- Sends one change to one order. Send `PURCHASE` first, then one event per change. The signature and the content are checked after the `202`. operationId: reportOrderEvent parameters: - $ref: '#/components/parameters/WebhookId' - $ref: '#/components/parameters/WebhookTimestamp' - $ref: '#/components/parameters/WebhookSignature' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OrderReport' examples: 'Ship and pickup: placed, card authorized': summary: 'Ship and pickup: placed, card authorized' description: >- Order 000481. A shipment line and a pickup line, with the card authorized for the full total. value: idempotencyKey: LOW-20261007-000481:purchase orderId: LOW-20261007-000481 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-07T14:02:11Z' order: type: PURCHASE status: PENDING closedAt: '2026-10-07T14:03:40Z' source: channel: ONLINE location: id: LOWES-ECOM name: Lowes.com e-commerce outlet address: line1: 1000 Lowes Blvd city: Mooresville state: NC postalCode: '28117' country: US merchantCategoryCode: '5200' merchantMid: LOWESECOM000001 lineItems: - lineItemId: l1 fulfillmentType: SHIPMENT sku: '1000720458' name: 20-Volt Max 1/2-in Cordless Drill/Driver Kit category: tools quantity: 1 basePrice: '179.00' grossSales: '179.00' discount: '0.00' tax: '12.08' total: '191.08' fulfillmentStatus: PENDING - lineItemId: l2 fulfillmentType: PICKUP sku: '1000074211' name: 2-in x 4-in x 8-ft Kiln-Dried Whitewood Stud category: lumber quantity: 3 basePrice: '4.28' grossSales: '12.84' discount: '0.00' tax: '0.87' total: '13.71' fulfillmentStatus: PENDING taxes: [] discounts: [] serviceCharges: [] netAmounts: subtotal: '191.84' discount: '0.00' tax: '12.95' serviceCharge: '0.00' tip: '0.00' total: '204.79' payments: - paymentId: LOWPAY-20261007-000481-1 type: CARD status: AUTHORIZED amount: '204.79' cardDetails: brand: MASTERCARD cardType: CREDIT last4: '4417' bin: '512345' isVirtual: false entryMethod: ECOMMERCE authResultCode: 7H2K9Q 'Ship and pickup: shipment left, first capture': summary: 'Ship and pickup: shipment left, first capture' description: >- The shipped line is fulfilled and its share of the card is captured. value: idempotencyKey: LOW-20261007-000481:fulfillment-1 orderId: LOW-20261007-000481 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-08T16:25:40Z' order: type: FULFILLMENT_UPDATED status: PARTIALLY_FULFILLED lineItems: - lineItemId: l1 fulfillmentStatus: FULFILLED carrier: UPS trackingNumber: 1Z999AA10123456784 - lineItemId: l2 fulfillmentStatus: PENDING payments: - paymentId: LOWPAY-20261007-000481-1 type: CARD status: CAPTURED amount: '191.08' cardDetails: brand: MASTERCARD cardType: CREDIT last4: '4417' bin: '512345' isVirtual: false entryMethod: ECOMMERCE authResultCode: 7H2K9Q 'Ship and pickup: pickup collected, final capture': summary: 'Ship and pickup: pickup collected, final capture' description: >- Every line is fulfilled. Captures now equal `netAmounts.total`, so points are awarded. value: idempotencyKey: LOW-20261007-000481:fulfillment-2 orderId: LOW-20261007-000481 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-09T18:45:02Z' order: type: FULFILLMENT_UPDATED status: FULFILLED lineItems: - lineItemId: l1 fulfillmentStatus: FULFILLED - lineItemId: l2 fulfillmentStatus: FULFILLED payments: - paymentId: LOWPAY-20261007-000481-1 type: CARD status: CAPTURED amount: '13.71' cardDetails: brand: MASTERCARD cardType: CREDIT last4: '4417' bin: '512345' isVirtual: false entryMethod: ECOMMERCE authResultCode: 7H2K9Q 'Ship and pickup: one line returned and refunded': summary: 'Ship and pickup: one line returned and refunded' description: A partial return with its card refund in the same event. value: idempotencyKey: LOW-20261007-000481-R1:return orderId: LOW-20261007-000481 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-14T15:12:33Z' order: type: RETURN status: PARTIALLY_RETURNED reason: Customer return - excess material returnLineItems: - returnId: LOW-20261007-000481-R1 lineItemId: l2 quantity: 1 payments: - paymentId: LOWPAY-20261007-000481-1 type: CARD status: REFUNDED refundId: LOW-20261007-000481-RF1 amount: '4.57' reason: Customer return - excess material Canceled before capture: summary: Canceled before capture description: >- Order 000502 is canceled and the card hold is voided in the same event. value: idempotencyKey: LOW-20261007-000502:cancel orderId: LOW-20261007-000502 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-07T21:05:48Z' order: type: ORDER_CANCELED status: CANCELED reason: Customer request - canceled before shipment payments: - paymentId: LOWPAY-20261007-000502-1 type: CARD status: VOIDED amount: '62.14' In store, paid by gift card: summary: In store, paid by gift card description: A walk-in sale paid by gift card. One event, and no points. value: idempotencyKey: LOW-20261007-000517:purchase orderId: LOW-20261007-000517 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-07T17:40:12Z' order: type: PURCHASE status: FULFILLED closedAt: '2026-10-07T17:40:12Z' source: channel: IN_STORE location: id: '0595' name: Lowe's of Mooresville address: line1: 509 River Hwy city: Mooresville state: NC postalCode: '28117' country: US merchantCategoryCode: '5200' merchantMid: LOWES0595000001 lineItems: - lineItemId: l1 fulfillmentType: IN_STORE sku: '1000521387' name: 9-in Woven Paint Roller Cover, 3-Pack category: paint quantity: 1 basePrice: '11.98' grossSales: '11.98' discount: '0.00' tax: '0.81' total: '12.79' fulfillmentStatus: FULFILLED taxes: [] discounts: [] serviceCharges: [] netAmounts: subtotal: '11.98' discount: '0.00' tax: '0.81' serviceCharge: '0.00' tip: '0.00' total: '12.79' payments: - paymentId: LOWPAY-20261007-000517-1 type: GIFT_CARD status: CAPTURED amount: '12.79' 'Split tender: gift card captured, card authorized': summary: 'Split tender: gift card captured, card authorized' description: >- Order 000530. The gift card is captured at the register and the card is put on hold. value: idempotencyKey: LOW-20261007-000530:purchase orderId: LOW-20261007-000530 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-07T18:02:30Z' order: type: PURCHASE status: PENDING closedAt: '2026-10-07T18:03:10Z' source: channel: ONLINE location: id: LOWES-ECOM name: Lowes.com e-commerce outlet address: line1: 1000 Lowes Blvd city: Mooresville state: NC postalCode: '28117' country: US merchantCategoryCode: '5200' merchantMid: LOWESECOM000001 lineItems: - lineItemId: l1 fulfillmentType: SHIPMENT sku: '1000720458' name: 20-Volt Max 1/2-in Cordless Drill/Driver Kit category: tools quantity: 1 basePrice: '70.09' grossSales: '70.09' discount: '0.00' tax: '4.91' total: '75.00' fulfillmentStatus: PENDING taxes: [] discounts: [] serviceCharges: [] netAmounts: subtotal: '70.09' discount: '0.00' tax: '4.91' serviceCharge: '0.00' tip: '0.00' total: '75.00' payments: - paymentId: LOWPAY-20261007-000530-1 type: GIFT_CARD status: CAPTURED amount: '25.00' - paymentId: LOWPAY-20261007-000530-2 type: CARD status: AUTHORIZED amount: '50.00' cardDetails: brand: VISA cardType: DEBIT last4: '0199' bin: '414720' isVirtual: false entryMethod: EMV authResultCode: Q9M2TX 'Split tender: card captured later': summary: 'Split tender: card captured later' description: Only money moved. Points are awarded on the card share. value: idempotencyKey: LOW-20261007-000530:payment-2-capture-1 orderId: LOW-20261007-000530 partnerMemberId: mylowes_9f3a7c1e2b8d4f60a5e3c9b7d1f2a4e6 currency: USD createdAt: '2026-10-09T12:40:05Z' order: type: PAYMENT_UPDATED status: PENDING payments: - paymentId: LOWPAY-20261007-000530-2 type: CARD status: CAPTURED amount: '50.00' cardDetails: brand: VISA cardType: DEBIT last4: '0199' bin: '414720' isVirtual: false entryMethod: EMV authResultCode: Q9M2TX responses: '202': description: >- Bilt stored the request and will check it within seconds. The outcome (`ACCEPTED`, `HELD`, or `REJECTED`, with a reason) is not in the response. No body. '400': description: >- A signing header is missing, longer than 1,024 bytes, or `webhook-timestamp` is not an integer. Nothing was stored. Do not retry unchanged. '413': description: The body is over 1 MiB. Nothing was stored. '500': description: >- Bilt could not store the request. Retry the same body with the same `webhook-id`, signed again with the current time, with backoff. security: - partnerSigning: [] servers: - url: https://webhooks.bilt.com description: Production - url: https://webhooks.staging.bilt.dev description: Staging components: parameters: WebhookId: name: webhook-id in: header required: true description: >- Unique ID for this request, and the deduplication key. Send the same value with the same body on every retry. The same value with a different body is `REJECTED` with `IDEMPOTENCY_KEY_REUSED`. schema: type: string minLength: 1 maxLength: 1024 example: msg_2Kq7d3V9xY1bN0cR5tE8wZ WebhookTimestamp: name: webhook-timestamp in: header required: true description: >- When you signed the request, in integer Unix seconds. Bilt rejects a timestamp more than 300 seconds from when it received the request (`stale_timestamp`). schema: type: string pattern: ^\d+$ maxLength: 1024 example: '1791381731' WebhookSignature: name: webhook-signature in: header required: true description: >- `v1a,` followed by the base64 Ed25519 signature of `{webhook-id}.{webhook-timestamp}.{raw body}`. You can send several space-separated entries during key rotation. Any one valid `v1a` entry passes, and other schemes are ignored. schema: type: string minLength: 1 maxLength: 1024 example: >- v1a,hnO3f9T8Ytu9HwrXslvumlUpqtNVqkhqw/enGzPCXe5BdqzCInXqYXFymVJaA7AZdpXwVLPo3mNl8EM+m7TBAg== schemas: OrderReport: type: object additionalProperties: false required: - idempotencyKey - orderId - partnerMemberId - currency - createdAt - order description: >- One change to one order. An unknown key anywhere in the event makes it `REJECTED` with `VALIDATION_FAILED`. properties: idempotencyKey: $ref: '#/components/schemas/Id' description: >- Unique per event. Send the same value, with the same body, on every retry of the event. orderId: $ref: '#/components/schemas/Id' description: Your ID for the order. The same on every event of the order. partnerMemberId: type: string maxLength: 256 pattern: ^\S(.*\S)?$ description: >- Your ID for the customer. It must equal, byte for byte, the value you used when they linked. No surrounding whitespace. currency: $ref: '#/components/schemas/Currency' createdAt: $ref: '#/components/schemas/Timestamp' description: When the change this event reports happened. order: $ref: '#/components/schemas/OrderReportOrder' payments: type: array minItems: 1 maxItems: 10 items: $ref: '#/components/schemas/PaymentEntry' description: >- One entry per tender whose money moved in this event. Send it only when money moved. Required on `PAYMENT_UPDATED`. Id: type: string pattern: ^[A-Za-z0-9._:-]{1,128}$ description: >- Your ID for an order, payment, return, refund, or event. Case-sensitive and compared byte for byte. Currency: type: string enum: - USD - CAD - GBP - EUR description: >- The currency of every amount in the order. The same on every event of the order. Timestamp: type: string pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$ description: RFC 3339 UTC with seconds, up to three fractional digits, and `Z` only. examples: - '2026-10-07T14:02:11Z' OrderReportOrder: description: What happened to the order. `type` selects the variant. oneOf: - $ref: '#/components/schemas/PurchaseOrder' - $ref: '#/components/schemas/FulfillmentUpdatedOrder' - $ref: '#/components/schemas/PaymentUpdatedOrder' - $ref: '#/components/schemas/OrderCanceledOrder' - $ref: '#/components/schemas/ReturnOrder' discriminator: propertyName: type mapping: PURCHASE: '#/components/schemas/PurchaseOrder' FULFILLMENT_UPDATED: '#/components/schemas/FulfillmentUpdatedOrder' PAYMENT_UPDATED: '#/components/schemas/PaymentUpdatedOrder' ORDER_CANCELED: '#/components/schemas/OrderCanceledOrder' RETURN: '#/components/schemas/ReturnOrder' PaymentEntry: type: object additionalProperties: false required: - paymentId - type - status - amount description: >- What happened to one tender in this event. `amount` is this change only. Card tenders go `AUTHORIZED`, then `CAPTURED` (repeatable), then `REFUNDED` (repeatable), or `AUTHORIZED` then `VOIDED`. Other tenders go `CAPTURED`, then `REFUNDED` (repeatable). properties: paymentId: $ref: '#/components/schemas/Id' description: The same on every event of this tender. Unique within the event. type: type: string enum: - CARD - CASH - GIFT_CARD - STORE_CREDIT - WALLET - BUY_NOW_PAY_LATER - BANK_ACCOUNT - OTHER status: type: string enum: - AUTHORIZED - CAPTURED - VOIDED - REFUNDED description: The tender status after this event. amount: $ref: '#/components/schemas/Money' cardDetails: $ref: '#/components/schemas/CardDetails' description: >- Required on a `CARD` entry that is `AUTHORIZED` or `CAPTURED`. Not allowed otherwise. refundId: $ref: '#/components/schemas/Id' description: 'Required on `REFUNDED`: this refund''s own ID. Not allowed otherwise.' reason: $ref: '#/components/schemas/Reason' description: Required on `REFUNDED`. Not allowed otherwise. PurchaseOrder: type: object title: PURCHASE additionalProperties: false required: - type - status - closedAt - source - location - lineItems - taxes - discounts - serviceCharges - netAmounts description: The order was placed. Send it once, as soon as checkout closes. properties: type: type: string const: PURCHASE status: $ref: '#/components/schemas/OrderStatus' description: >- `PENDING` when nothing is fulfilled yet, or `FULFILLED` for a walk-in sale. closedAt: $ref: '#/components/schemas/Timestamp' description: >- When your point of sale closed the order. At or after the event `createdAt`. source: type: object additionalProperties: false required: - channel properties: channel: type: string enum: - ONLINE - IN_STORE - PHONE - MARKETPLACE - OTHER location: $ref: '#/components/schemas/Location' lineItems: type: array minItems: 1 maxItems: 100 items: $ref: '#/components/schemas/OrderLineItem' taxes: type: array maxItems: 20 items: $ref: '#/components/schemas/OrderAdjustment' description: Order-level taxes not already on a line. Send `[]` when none. discounts: type: array maxItems: 20 items: $ref: '#/components/schemas/OrderAdjustment' description: Order-level discounts not already on a line. Send `[]` when none. serviceCharges: type: array maxItems: 20 items: $ref: '#/components/schemas/ServiceCharge' description: >- Fees that are not products. A tip is not a service charge. Send `[]` when none. netAmounts: $ref: '#/components/schemas/NetAmounts' FulfillmentUpdatedOrder: type: object title: FULFILLMENT_UPDATED additionalProperties: false required: - type - status - lineItems description: >- A line status changed. List every line of the purchase exactly once, as it stands now. properties: type: type: string const: FULFILLMENT_UPDATED status: $ref: '#/components/schemas/OrderStatus' description: '`PENDING`, `PARTIALLY_FULFILLED`, or `FULFILLED`.' lineItems: type: array minItems: 1 maxItems: 100 items: type: object additionalProperties: false required: - lineItemId - fulfillmentStatus properties: lineItemId: $ref: '#/components/schemas/LineItemId' fulfillmentStatus: $ref: '#/components/schemas/LineItemFulfillmentStatus' carrier: type: string minLength: 1 maxLength: 64 description: Who carried the goods, such as `UPS`. trackingNumber: type: string minLength: 1 maxLength: 128 description: The carrier tracking number. PaymentUpdatedOrder: type: object title: PAYMENT_UPDATED additionalProperties: false required: - type - status description: >- Only money moved and nothing changed on the order. `payments` is required. properties: type: type: string const: PAYMENT_UPDATED status: $ref: '#/components/schemas/OrderStatus' description: Restates the current order status. OrderCanceledOrder: type: object title: ORDER_CANCELED additionalProperties: false required: - type - status - reason description: >- Nothing more will ship. Lines already fulfilled stay fulfilled. Money moves only through `payments`. properties: type: type: string const: ORDER_CANCELED status: $ref: '#/components/schemas/OrderStatus' description: '`CANCELED`.' reason: $ref: '#/components/schemas/Reason' ReturnOrder: type: object title: RETURN additionalProperties: false required: - type - status - reason - returnLineItems description: >- Goods came back. Money moves only through `payments`, in this event or a later `PAYMENT_UPDATED`. properties: type: type: string const: RETURN status: $ref: '#/components/schemas/OrderStatus' description: '`PARTIALLY_RETURNED`, or `RETURNED` when everything is back.' reason: $ref: '#/components/schemas/Reason' returnLineItems: type: array minItems: 1 maxItems: 100 items: type: object additionalProperties: false required: - returnId - lineItemId - quantity properties: returnId: $ref: '#/components/schemas/Id' description: >- Your ID for this returned item. Unique for your integration and within the event. lineItemId: $ref: '#/components/schemas/LineItemId' description: A `lineItemId` of the purchase. quantity: $ref: '#/components/schemas/Quantity' description: What came back in this return, not a running total. Money: type: string pattern: ^\d{1,12}\.\d{2}$ description: >- Decimal string with exactly two decimals, never negative. Zero is `"0.00"`. Never a JSON number. examples: - '204.79' CardDetails: type: object additionalProperties: false required: - brand - cardType - last4 - bin - isVirtual - entryMethod - authResultCode description: The card used. The same card on every entry of a tender. properties: brand: type: string enum: - VISA - MASTERCARD - AMERICAN_EXPRESS - DISCOVER - PRIVATE_LABEL - OTHER cardType: type: string enum: - CREDIT - DEBIT - PREPAID last4: type: string pattern: ^\d{4}$ bin: type: string pattern: ^\d{6,8}$ description: Bilt does not check it against `brand`. isVirtual: type: boolean description: '`true` for a wallet token or virtual card number.' entryMethod: type: string enum: - KEYED - SWIPED - EMV - CONTACTLESS - ON_FILE - ECOMMERCE description: >- `KEYED` is typed by your staff, `ON_FILE` is a stored credential, and `ECOMMERCE` is entered by the customer online. authResultCode: type: string pattern: ^[A-Za-z0-9]{6}$ description: The issuer approval code. Reason: type: string maxLength: 256 description: Free text. OrderStatus: type: string enum: - PENDING - PARTIALLY_FULFILLED - FULFILLED - PARTIALLY_RETURNED - RETURNED - CANCELED description: >- The order status after the event, rolled up from its lines. Each `order.type` allows only some values, otherwise the event is `REJECTED` with `STATUS_MISMATCH`. Location: type: object additionalProperties: false required: - id - name - address - merchantCategoryCode - merchantMid description: >- The outlet the sale clears under: the store for `IN_STORE`, or your e-commerce outlet for `ONLINE`, `PHONE`, and `MARKETPLACE`. properties: id: $ref: '#/components/schemas/Id' description: >- Your stable ID for the outlet. Its `merchantMid` and `merchantCategoryCode` never change. name: type: string maxLength: 256 phone: type: string pattern: ^\+[1-9]\d{6,14}$ description: E.164 phone number. address: $ref: '#/components/schemas/Address' merchantCategoryCode: type: string pattern: ^\d{4}$ description: ISO 18245 merchant category code. merchantMid: type: string pattern: ^[A-Za-z0-9]{1,64}$ description: The acquirer merchant ID card transactions clear under. OrderLineItem: type: object additionalProperties: false required: - lineItemId - fulfillmentType - sku - name - category - quantity - basePrice - grossSales - discount - tax - total - fulfillmentStatus properties: lineItemId: $ref: '#/components/schemas/LineItemId' fulfillmentType: type: string enum: - SHIPMENT - PICKUP - DELIVERY - IN_STORE description: >- How the line reaches the customer. A line that goes out two ways is two lines. sku: type: string pattern: ^[A-Za-z0-9._-]{1,64}$ name: type: string maxLength: 256 category: type: string maxLength: 64 quantity: $ref: '#/components/schemas/Quantity' basePrice: $ref: '#/components/schemas/Money' grossSales: $ref: '#/components/schemas/Money' description: '`basePrice × quantity`.' discount: $ref: '#/components/schemas/Money' description: '`"0.00"` when none.' tax: $ref: '#/components/schemas/Money' description: '`"0.00"` when none.' total: $ref: '#/components/schemas/Money' description: '`grossSales − discount + tax`.' fulfillmentStatus: $ref: '#/components/schemas/LineItemFulfillmentStatus' OrderAdjustment: type: object additionalProperties: false required: - name - applied properties: name: type: string maxLength: 128 percentage: type: string pattern: ^\d{1,3}(\.\d{1,4})?$ description: Only for a percentage tax or discount. At most 100. applied: $ref: '#/components/schemas/Money' ServiceCharge: type: object additionalProperties: false required: - name - kind - taxable - applied properties: name: type: string maxLength: 128 kind: type: string enum: - DELIVERY - SHIPPING - SERVICE - SMALL_ORDER - BAG - PACKAGING - REGULATORY - INSTALLATION - ASSEMBLY - HAUL_AWAY - DEPOSIT - OTHER taxable: type: boolean applied: $ref: '#/components/schemas/Money' NetAmounts: type: object additionalProperties: false required: - subtotal - discount - tax - serviceCharge - tip - total description: The order totals. Bilt checks them against the lines. properties: subtotal: $ref: '#/components/schemas/Money' description: Sum of `lineItems[].grossSales`. discount: $ref: '#/components/schemas/Money' description: Sum of `lineItems[].discount` plus sum of `discounts[].applied`. tax: $ref: '#/components/schemas/Money' description: Sum of `lineItems[].tax` plus sum of `taxes[].applied`. serviceCharge: $ref: '#/components/schemas/Money' description: Sum of `serviceCharges[].applied`. tip: $ref: '#/components/schemas/Money' description: The gratuity. `"0.00"` when none. total: $ref: '#/components/schemas/Money' description: >- `subtotal − discount + tax + serviceCharge + tip`. Points are awarded once captures across all tenders add up to exactly this value. LineItemId: type: string pattern: ^[A-Za-z0-9._-]{1,64}$ description: >- Your ID for one line of an order. Unique within the purchase and never reused. LineItemFulfillmentStatus: type: string enum: - PENDING - FULFILLED - CANCELED description: >- `FULFILLED` means the goods left your control, not that they were delivered. Quantity: type: number exclusiveMinimum: 0 maximum: 1000000000 description: JSON number greater than zero with at most three decimals. Address: type: object additionalProperties: false required: - line1 - city - state - postalCode - country properties: line1: type: string maxLength: 256 line2: type: string maxLength: 256 city: type: string maxLength: 128 state: type: string maxLength: 64 description: >- For US and CA, the ISO 3166-2 subdivision code without the country prefix, such as `NC`. postalCode: type: string pattern: ^[A-Za-z0-9 -]{3,10}$ country: type: string pattern: ^[A-Z]{2}$ description: ISO 3166-1 alpha-2, upper case. securitySchemes: partnerBearer: type: http scheme: bearer bearerFormat: JWT description: > Preferred. An access token your partner client mints with the client credentials grant. Send it only on the `Authorization` header. It is not the member access token from the code exchange. apiKey: type: apiKey in: header name: x-api-key description: > Being retired in favor of the partner access token. Do not send both: a rejected bearer token does not fall back to the key. partnerSigning: type: apiKey in: header name: X-Bilt-Key-Id description: >- Order reports are signed, not sent with a token. Send the key ID Bilt issued when you registered your Ed25519 public key in `X-Bilt-Key-Id`, and sign each request with the Standard Webhooks `v1a` scheme in the `webhook-*` headers. See [Sign your requests](/partners/order-reporting/sign-your-requests). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.