order library
Orders, line items, documents, checkout settings, and request models.
Import this library as order alongside package:inttegro/inttegro.dart.
Classes
- Address
- A postal or contact address attached to an order.
- CancelRequest
- Identifies the order to cancel and supplies any cancellation options.
- CheckoutSettings
- Settings that control order behavior.
- CompleteRequest
- Parameters for marking an order complete.
- CreatedFrom
- The source resource from which an order was created.
- CreatedFromResourceType
- The resource type from which an order was created.
- CreateExistingCustomerInput
- Parameters for creating an order for an existing customer.
- CreateExistingCustomerInputCheckoutSettings
- Checkout redirects supplied when creating an order for an existing customer.
- CreateExistingCustomerInputRequestMeta
- Request metadata for order operations.
- CreateNewCustomerInput
- Parameters for creating an order and a new customer together.
- CreateNewCustomerInputCheckoutSettings
- Checkout redirects supplied when creating an order for a new customer.
- CreateNewCustomerInputRequestMeta
- Request metadata for order operations.
- CreateRequest
- Customer
- The customer snapshot attached to an order.
- Discount
- Discount marker returned by the API.
- DiscountLineItem
- A discount line item attached to an order.
- DiscountLineItemVariant
- DocumentDelivery
- The delivery state of an order invoice or receipt.
- DocumentDeliveryAttempt
- A Chime delivery attempt for an order document.
- DocumentDeliveryFailure
- A failed delivery channel and its error for an order document.
- DocumentDeliveryRequest
- Identifies the order whose document should be delivered.
- DocumentDeliveryResult
- The result of requesting delivery of an order document.
- DocumentFormat
- The URL of one available order-document format.
- DocumentKind
- The kind of customer-facing document associated with an order.
- ExistingCustomerCreateRequest
- FeeDetailsInput
- Fee details fields accepted by the order API.
- FeeLineItem
- A fee line item attached to an order.
- FeeLineItemFee
- The fee details embedded in an order line item.
- FeeLineItemInput
- Fee line item fields accepted by the order API.
- FeeLineItemInputVariant
- FeeLineItemVariant
- FinalizeRequest
- Identifies the order to finalize.
- Invoice
- Invoice metadata and available document formats for an order.
- InvoiceFormat
- Links to the web and PDF forms of an invoice.
- LineItem
- LineItemGroup
- An order's line items and their aggregate total.
- LineItemInput
- LineItemType
- The commercial role of an order line item.
- LookupRequest
- Identifies the order to retrieve.
- NewCustomerCreateRequest
- Order
- An order, its customer, line items, payment, and issued documents.
- Page
- A page of orders returned by a list operation.
- PageRequest
- Pagination and filtering parameters for listing orders.
- PayoutSettingsRequest
- Payout destination and foreign-exchange settings supplied for an order.
- PayoutSettingsRequestDestination
- The financial account selected as an order's payout destination.
- PayRequest
- Parameters for paying an order.
- ProductLineItem
- A product line item attached to an order.
- ProductLineItemInputVariant
- ProductLineItemProduct
- The product, price, and quantity snapshot embedded in an order line item.
- ProductLineItemVariant
- Receipt
- Receipt issued for a paid order payment.
- ReceiptFormat
- Hosted document formats for a payment receipt.
- RequestConfirmationRequest
- Identifies the order that needs a new payment confirmation.
- ShippingInput
- Shipping fields accepted by the order API.
- ShippingLineItem
- A shipping-fee line item attached to an order.
- ShippingLineItemInput
- Shipping line item fields accepted by the order API.
- ShippingLineItemInputVariant
- ShippingLineItemShipping
- The shipping fee details embedded in an order line item.
- ShippingLineItemVariant
- Status
- The current lifecycle state of an Order.
- UpdateRequest
- Parameters for updating an order.
- UpdateRequestPaymentMethodData
- Inline payment-method data supplied while updating an order.
- UpdateRequestPaymentMethodDataMobileMoney
- Mobile-money account data supplied while updating an order.