# Calicantus OMS API

> GraphQL API of the Calicantus Order Management System: getting started, guides, webhooks and reference.

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [Welcome](https://docs.api.oms.calicant.us/index.md): Integrate the Calicantus Order Management System through its GraphQL API: the essential facts before you start, and where to begin based on what yo...
- [Authentication](https://docs.api.oms.calicant.us/getting-started/authentication.md): Authentication guidelines for OMS API.
- [Client Setup](https://docs.api.oms.calicant.us/getting-started/client-setup.md): Run your first queries against the OMS API from the Playground or from a GraphQL client.
- [Endpoints](https://docs.api.oms.calicant.us/getting-started/endpoints.md): URLs and environments details of OMS API.
- [Errors](https://docs.api.oms.calicant.us/getting-started/errors.md): How the OMS API reports errors and the most common error codes.
- [Filtering](https://docs.api.oms.calicant.us/getting-started/filtering.md): How to build filters for list queries in the OMS API.
- [Introduction to GraphQL](https://docs.api.oms.calicant.us/getting-started/intro.md): A quick introduction to GraphQL: queries, mutations, fragments and variables.
- [Pagination](https://docs.api.oms.calicant.us/getting-started/pagination.md): How cursor-based pagination works in the OMS API: connections, page size, cursors and total counts.
- [Rate limiting](https://docs.api.oms.calicant.us/getting-started/rate-limiting.md): How the OMS API rate limiting (query complexity bucket) works.
- [Get brand products](https://docs.api.oms.calicant.us/guides/brand/brand_products.md): Browse the products and bundles of a brand, with their availabilities.
- [Get order details](https://docs.api.oms.calicant.us/guides/orders/order_details.md): Read a single order with its lines, billing data, shippings and warehouse information.
- [Get order documents](https://docs.api.oms.calicant.us/guides/orders/order_documents.md): Retrieve the accounting documents, proformas and shipping labels of an order — all together, or just the latest invoice with the labels.
- [Import an order](https://docs.api.oms.calicant.us/guides/orders/order_import.md): Submit a new order for a channel: required fields, validation rules and complete runnable examples.
- [Query orders with filters](https://docs.api.oms.calicant.us/guides/orders/order_queries.md): Retrieve orders with filters: creation date, status, fulfillment, tracking number, billing email or delivery ID.
- [Order and shipping statuses](https://docs.api.oms.calicant.us/guides/orders/things_to_know.md): The order status and the three shipping statuses (carrier tracking, warehouse fulfilment, label booking) of the OMS and what they mean.
- [Create and update external disputes](https://docs.api.oms.calicant.us/guides/payments/payment_disputes.md): Record and update the disputes of an external payment gateway.
- [Query external transactions and disputes](https://docs.api.oms.calicant.us/guides/payments/payment_queries.md): Query the external transactions and disputes recorded for your payment merchants.
- [Create, update and refund external transactions](https://docs.api.oms.calicant.us/guides/payments/payment_transactions.md): Record the activity of an external payment gateway: create, update and refund transactions.
- [Payment transaction and dispute statuses](https://docs.api.oms.calicant.us/guides/payments/things_to_know.md): The lifecycle of external payment transactions and disputes: submittable statuses, derived statuses and the allowed transitions.
- [Get repayment request details](https://docs.api.oms.calicant.us/guides/repayments/repayment_detail.md): Read a single repayment request with its causal, lines, returned lines and shipping.
- [Get repayment documents](https://docs.api.oms.calicant.us/guides/repayments/repayment_documents.md): Retrieve the accounting documents and shipping labels of a repayment request.
- [Query repayment requests](https://docs.api.oms.calicant.us/guides/repayments/repayment_queries.md): Retrieve the repayment requests of an order, or find them with filters: request number, status and update date.
- [Manage returned lines](https://docs.api.oms.calicant.us/guides/repayments/repayment_return_lines.md): Set the received and compliant quantities of returned lines, add missing ones and confirm the reception.
- [Repayment request statuses and return reasons](https://docs.api.oms.calicant.us/guides/repayments/things_to_know.md): The lifecycle of a repayment request (return), what each status means and the return reasons (causals) a request can carry.
- [Confirm or cancel a fulfilment](https://docs.api.oms.calicant.us/guides/shipping/shipping_fulfillment.md): Declare the parcels and the quantities packed by an external warehouse, or cancel the fulfilment of a shipping.
- [Get shipping rates](https://docs.api.oms.calicant.us/guides/shipping/shipping_rates.md): Compute the available shipping rates for a recipient address and a set of parcels.
- [Update warehouse availabilities](https://docs.api.oms.calicant.us/guides/warehouse/warehouse_availabilities.md): Update the product availabilities of a warehouse in bulk.
- [Query warehouse availabilities](https://docs.api.oms.calicant.us/guides/warehouse/warehouse_queries.md): Query the product availabilities of a warehouse.
- [External warehouse integration](https://docs.api.oms.calicant.us/use-cases/external_warehouse.md): Integrate an external warehouse with OMS: pull the orders to fulfil, declare the parcels and quantities packed, and evaluate and confirm the return...
- [Payment gateway integration](https://docs.api.oms.calicant.us/use-cases/payment_gateway.md): Integrate a payment gateway with OMS: push the e-commerce transactions with their fees, report disputes and execute the refunds requested by OMS.
- [Events](https://docs.api.oms.calicant.us/webhooks/events.md): The OMS currently emits the events listed below. Every event follows the payload structure described in [Introduction to Webhooks](./intro#event-pa...
- [Introduction to Webhooks](https://docs.api.oms.calicant.us/webhooks/intro.md): Webhooks let your integration receive events from OMS as they happen. Webhooks are enabled and configured for you by Calicantus: to register your e...
- [deprecated](https://docs.api.oms.calicant.us/graphql/directives/deprecated.md): Marks an element of a GraphQL schema as no longer supported.
- [include](https://docs.api.oms.calicant.us/graphql/directives/include.md): Directs the executor to include this field or fragment only when the `if` argument is true.
- [oneOf](https://docs.api.oms.calicant.us/graphql/directives/one-of.md): Requires that exactly one field must be supplied and that field must not be `null`.
- [skip](https://docs.api.oms.calicant.us/graphql/directives/skip.md): Directs the executor to skip this field or fragment when the `if` argument is true.
- [specifiedBy](https://docs.api.oms.calicant.us/graphql/directives/specified-by.md): Exposes a URL that specifies the behavior of this scalar.
- [ChannelPlatform](https://docs.api.oms.calicant.us/graphql/enums/channel-platform.md): No description
- [OrderCustomerLanguageInput](https://docs.api.oms.calicant.us/graphql/enums/order-customer-language-input.md): No description
- [OrderLineKind](https://docs.api.oms.calicant.us/graphql/enums/order-line-kind.md): No description
- [OrderStatus](https://docs.api.oms.calicant.us/graphql/enums/order-status.md): The lifecycle status of an order inside OMS.
- [PaymentDisputeStatus](https://docs.api.oms.calicant.us/graphql/enums/payment-dispute-status.md): No description
- [PaymentExternalDisputeStatusInput](https://docs.api.oms.calicant.us/graphql/enums/payment-external-dispute-status-input.md): No description
- [PaymentExternalTransactionStatusInput](https://docs.api.oms.calicant.us/graphql/enums/payment-external-transaction-status-input.md): No description
- [PaymentTransactionStatus](https://docs.api.oms.calicant.us/graphql/enums/payment-transaction-status.md): No description
- [RepaymentCausalRefundKind](https://docs.api.oms.calicant.us/graphql/enums/repayment-causal-refund-kind.md): No description
- [RepaymentStatus](https://docs.api.oms.calicant.us/graphql/enums/repayment-status.md): The lifecycle status of a repayment request (return).
- [ShippingBookingStatus](https://docs.api.oms.calicant.us/graphql/enums/shipping-booking-status.md): The state of the booking process that produces the shipping label (waybill) for a shipping.
- [ShippingFulfillmentStatus](https://docs.api.oms.calicant.us/graphql/enums/shipping-fulfillment-status.md): How much of a shipping has been fulfilled by the warehouse.
- [ShippingParcelKind](https://docs.api.oms.calicant.us/graphql/enums/shipping-parcel-kind.md): No description
- [ShippingStatus](https://docs.api.oms.calicant.us/graphql/enums/shipping-status.md): The carrier tracking state of a parcel.
- [AccountingOrderProformaComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/accounting-order-proforma-comparison-input.md): No description
- [AccountingOrderProformaComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/accounting-order-proforma-complex-filter-input.md): No description
- [AccountingRepaymentProformaComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/accounting-repayment-proforma-comparison-input.md): No description
- [AccountingRepaymentProformaComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/accounting-repayment-proforma-complex-filter-input.md): No description
- [BillingComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/billing-comparison-input.md): No description
- [BillingComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/billing-complex-filter-input.md): No description
- [BooleanComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/boolean-comparison-input.md): No description
- [BrandComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/brand-comparison-input.md): No description
- [BrandComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/brand-complex-filter-input.md): No description
- [ChannelComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/channel-comparison-input.md): No description
- [ChannelComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/channel-complex-filter-input.md): No description
- [ChannelPlatformComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/channel-platform-comparison-input.md): No description
- [DisputeComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/dispute-comparison-input.md): No description
- [DisputeComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/dispute-complex-filter-input.md): No description
- [DisputeListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/dispute-list-comparison-input.md): No description
- [FloatComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/float-comparison-input.md): No description
- [FulfillmentLineComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/fulfillment-line-comparison-input.md): No description
- [FulfillmentLineComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/fulfillment-line-complex-filter-input.md): No description
- [FulfillmentLineListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/fulfillment-line-list-comparison-input.md): No description
- [FulfillmentPackingComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/fulfillment-packing-comparison-input.md): No description
- [FulfillmentPackingComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/fulfillment-packing-complex-filter-input.md): No description
- [IDComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/idcomparison-input.md): No description
- [IntComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/int-comparison-input.md): No description
- [ISO8601DateTimeComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/iso8601-date-time-comparison-input.md): No description
- [OrderComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-comparison-input.md): No description
- [OrderComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/order-complex-filter-input.md): No description
- [OrderCustomerActionComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-action-comparison-input.md): No description
- [OrderCustomerActionComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-action-complex-filter-input.md): No description
- [OrderCustomerActionListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-action-list-comparison-input.md): No description
- [OrderCustomerAddressInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-address-input.md): No description
- [OrderCustomerBillingInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-billing-input.md): No description
- [OrderCustomerZendeskConversationInput](https://docs.api.oms.calicant.us/graphql/inputs/order-customer-zendesk-conversation-input.md): No description
- [OrderImportBillingInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-billing-input.md): No description
- [OrderImportInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-input.md): No description
- [OrderImportLineInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-line-input.md): No description
- [OrderImportParcelInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-parcel-input.md): No description
- [OrderImportShippingInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-shipping-input.md): No description
- [OrderImportShippingOrderLineInput](https://docs.api.oms.calicant.us/graphql/inputs/order-import-shipping-order-line-input.md): No description
- [OrderLineComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-line-comparison-input.md): No description
- [OrderLineComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/order-line-complex-filter-input.md): No description
- [OrderLineKindComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-line-kind-comparison-input.md): No description
- [OrderLineListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-line-list-comparison-input.md): No description
- [OrderStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/order-status-comparison-input.md): No description
- [PaymentDisputeStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-dispute-status-comparison-input.md): No description
- [PaymentExternalDisputeComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-dispute-comparison-input.md): No description
- [PaymentExternalDisputeComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-dispute-complex-filter-input.md): No description
- [PaymentExternalDisputeCreateInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-dispute-create-input.md): No description
- [PaymentExternalDisputeUpdateInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-dispute-update-input.md): No description
- [PaymentExternalTransactionComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-comparison-input.md): No description
- [PaymentExternalTransactionComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-complex-filter-input.md): No description
- [PaymentExternalTransactionCreateFeeInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-create-fee-input.md): No description
- [PaymentExternalTransactionCreateInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-create-input.md): No description
- [PaymentExternalTransactionListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-list-comparison-input.md): No description
- [PaymentExternalTransactionRefundFeeInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-refund-fee-input.md): No description
- [PaymentExternalTransactionRefundInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-refund-input.md): No description
- [PaymentExternalTransactionUpdateFeeInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-update-fee-input.md): No description
- [PaymentExternalTransactionUpdateInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-external-transaction-update-input.md): No description
- [PaymentGatewayComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-gateway-comparison-input.md): No description
- [PaymentGatewayComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-gateway-complex-filter-input.md): No description
- [PaymentMerchantComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-merchant-comparison-input.md): No description
- [PaymentMerchantComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-merchant-complex-filter-input.md): No description
- [PaymentMerchantListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-merchant-list-comparison-input.md): No description
- [PaymentTransactionFeeComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-transaction-fee-comparison-input.md): No description
- [PaymentTransactionFeeComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-transaction-fee-complex-filter-input.md): No description
- [PaymentTransactionFeeListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-transaction-fee-list-comparison-input.md): No description
- [PaymentTransactionStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/payment-transaction-status-comparison-input.md): No description
- [ProductBundleAvailabilityComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-availability-comparison-input.md): No description
- [ProductBundleAvailabilityComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-availability-complex-filter-input.md): No description
- [ProductBundleAvailabilityListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-availability-list-comparison-input.md): No description
- [ProductBundleComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-comparison-input.md): No description
- [ProductBundleComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-complex-filter-input.md): No description
- [ProductBundleListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-bundle-list-comparison-input.md): No description
- [ProductComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-comparison-input.md): No description
- [ProductComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/product-complex-filter-input.md): No description
- [ProductComponentComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-component-comparison-input.md): No description
- [ProductComponentComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/product-component-complex-filter-input.md): No description
- [ProductComponentListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-component-list-comparison-input.md): No description
- [ProductListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-list-comparison-input.md): No description
- [ProductProductAvailabilityComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-product-availability-comparison-input.md): No description
- [ProductProductAvailabilityComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/product-product-availability-complex-filter-input.md): No description
- [ProductProductAvailabilityListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/product-product-availability-list-comparison-input.md): No description
- [RepaymentCausalComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-causal-comparison-input.md): No description
- [RepaymentCausalComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-causal-complex-filter-input.md): No description
- [RepaymentCausalRefundKindComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-causal-refund-kind-comparison-input.md): No description
- [RepaymentLineComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-line-comparison-input.md): No description
- [RepaymentLineComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-line-complex-filter-input.md): No description
- [RepaymentLineListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-line-list-comparison-input.md): No description
- [RepaymentRequestComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-request-comparison-input.md): No description
- [RepaymentRequestComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-request-complex-filter-input.md): No description
- [RepaymentRequestListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-request-list-comparison-input.md): No description
- [RepaymentReturnedLineComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-returned-line-comparison-input.md): No description
- [RepaymentReturnedLineComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-returned-line-complex-filter-input.md): No description
- [RepaymentReturnedLineCreateInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-returned-line-create-input.md): No description
- [RepaymentReturnedLineEvaluationConfirmInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-returned-line-evaluation-confirm-input.md): No description
- [RepaymentReturnedLineListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-returned-line-list-comparison-input.md): No description
- [RepaymentShippingComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-shipping-comparison-input.md): No description
- [RepaymentShippingComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-shipping-complex-filter-input.md): No description
- [RepaymentStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/repayment-status-comparison-input.md): No description
- [ShippingBookingStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-booking-status-comparison-input.md): No description
- [ShippingCarrierComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-carrier-comparison-input.md): No description
- [ShippingCarrierComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-carrier-complex-filter-input.md): No description
- [ShippingComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-comparison-input.md): No description
- [ShippingComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-complex-filter-input.md): No description
- [ShippingEventComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-event-comparison-input.md): No description
- [ShippingEventComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-event-complex-filter-input.md): No description
- [ShippingEventListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-event-list-comparison-input.md): No description
- [ShippingFulfillmentConfirmLineInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-fulfillment-confirm-line-input.md): The fulfilment of a shipping line, or of a part of it: the same shippingLineId can appear more than once to declare different serial numbers or bat...
- [ShippingFulfillmentConfirmParcelInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-fulfillment-confirm-parcel-input.md): A parcel prepared by the warehouse. Same fields and units as ShippingParcel.
- [ShippingFulfillmentStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-fulfillment-status-comparison-input.md): No description
- [ShippingLabelComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-label-comparison-input.md): No description
- [ShippingLabelComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-label-complex-filter-input.md): No description
- [ShippingLabelListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-label-list-comparison-input.md): No description
- [ShippingLineComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-line-comparison-input.md): No description
- [ShippingLineComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-line-complex-filter-input.md): No description
- [ShippingLineListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-line-list-comparison-input.md): No description
- [ShippingListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-list-comparison-input.md): No description
- [ShippingParcelComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-parcel-comparison-input.md): No description
- [ShippingParcelComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-parcel-complex-filter-input.md): No description
- [ShippingParcelKindComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-parcel-kind-comparison-input.md): No description
- [ShippingParcelListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-parcel-list-comparison-input.md): No description
- [ShippingRatesParcelInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-rates-parcel-input.md): No description
- [ShippingRatesRecipientAddressInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-rates-recipient-address-input.md): No description
- [ShippingRatesValueInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-rates-value-input.md): No description
- [ShippingStatusComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/shipping-status-comparison-input.md): No description
- [StockBatchComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/stock-batch-comparison-input.md): No description
- [StockBatchComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/stock-batch-complex-filter-input.md): No description
- [StringComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/string-comparison-input.md): No description
- [StringListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/string-list-comparison-input.md): No description
- [TransactionComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/transaction-comparison-input.md): No description
- [TransactionComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/transaction-complex-filter-input.md): No description
- [TransactionListComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/transaction-list-comparison-input.md): No description
- [WarehouseAvailabilitiesBulkUpdateInput](https://docs.api.oms.calicant.us/graphql/inputs/warehouse-availabilities-bulk-update-input.md): No description
- [WarehouseAvailabilitiesBulkUpdateProductAvailabilityInput](https://docs.api.oms.calicant.us/graphql/inputs/warehouse-availabilities-bulk-update-product-availability-input.md): No description
- [WarehouseComparisonInput](https://docs.api.oms.calicant.us/graphql/inputs/warehouse-comparison-input.md): No description
- [WarehouseComplexFilterInput](https://docs.api.oms.calicant.us/graphql/inputs/warehouse-complex-filter-input.md): No description
- [Availability](https://docs.api.oms.calicant.us/graphql/interfaces/availability.md): No description
- [BaseProduct](https://docs.api.oms.calicant.us/graphql/interfaces/base-product.md): No description
- [BaseShipping](https://docs.api.oms.calicant.us/graphql/interfaces/base-shipping.md): No description
- [Dispute](https://docs.api.oms.calicant.us/graphql/interfaces/dispute.md): No description
- [Document](https://docs.api.oms.calicant.us/graphql/interfaces/document.md): No description
- [Transaction](https://docs.api.oms.calicant.us/graphql/interfaces/transaction.md): No description
- [customerCancelOrder](https://docs.api.oms.calicant.us/graphql/mutations/customer-cancel-order.md): Cancels an order on behalf of the customer.
- [customerModifyShippingAddress](https://docs.api.oms.calicant.us/graphql/mutations/customer-modify-shipping-address.md): Modifies the shipping address of an order on behalf of the customer.
- [customerReleaseShippingStorage](https://docs.api.oms.calicant.us/graphql/mutations/customer-release-shipping-storage.md): Releases a shipping held in storage on behalf of the customer.
- [customerRequestInvoice](https://docs.api.oms.calicant.us/graphql/mutations/customer-request-invoice.md): Requests an invoice for an order on behalf of the customer.
- [orderImport](https://docs.api.oms.calicant.us/graphql/mutations/order-import.md): Imports a new order for a channel.
- [paymentExternalDisputeCreate](https://docs.api.oms.calicant.us/graphql/mutations/payment-external-dispute-create.md): Records a new dispute on an external transaction.
- [paymentExternalDisputeUpdate](https://docs.api.oms.calicant.us/graphql/mutations/payment-external-dispute-update.md): Updates an existing external dispute.
- [paymentExternalTransactionCreate](https://docs.api.oms.calicant.us/graphql/mutations/payment-external-transaction-create.md): Records a new external payment transaction.
- [paymentExternalTransactionRefund](https://docs.api.oms.calicant.us/graphql/mutations/payment-external-transaction-refund.md): Creates a refund for an existing external transaction.
- [paymentExternalTransactionUpdate](https://docs.api.oms.calicant.us/graphql/mutations/payment-external-transaction-update.md): Updates an existing external payment transaction.
- [repaymentReturnLinesEvaluationConfirm](https://docs.api.oms.calicant.us/graphql/mutations/repayment-return-lines-evaluation-confirm.md): Confirms the warehouse evaluation of a repayment request.
- [repaymentReturnedLineCreate](https://docs.api.oms.calicant.us/graphql/mutations/repayment-returned-line-create.md): Adds a returned line to a repayment request for an item received but not expected as part of the return.
- [repaymentReturnedLineSetQuantities](https://docs.api.oms.calicant.us/graphql/mutations/repayment-returned-line-set-quantities.md): Sets the received and compliant quantities of a returned line.
- [shippingFulfillmentCancel](https://docs.api.oms.calicant.us/graphql/mutations/shipping-fulfillment-cancel.md): Cancels the fulfilment of a shipping by an external warehouse that validates the shippings (a per-project setup): nothing is packed and nothing is ...
- [shippingFulfillmentConfirm](https://docs.api.oms.calicant.us/graphql/mutations/shipping-fulfillment-confirm.md): Confirms the fulfilment of a shipping by an external warehouse that validates the shippings (a per-project setup): the parcels prepared and, option...
- [warehouseAvailabilitiesBulkUpdate](https://docs.api.oms.calicant.us/graphql/mutations/warehouse-availabilities-bulk-update.md): Sets the on-hand quantities for products of a brand in a warehouse.
- [AccountingCreditDocument](https://docs.api.oms.calicant.us/graphql/objects/accounting-credit-document.md): Permission required: accounting_document:read
- [AccountingOrderProforma](https://docs.api.oms.calicant.us/graphql/objects/accounting-order-proforma.md): Permission required: accounting_proforma:read
- [AccountingRepaymentProforma](https://docs.api.oms.calicant.us/graphql/objects/accounting-repayment-proforma.md): Permission required: accounting_proforma:read
- [AccountingSaleDocument](https://docs.api.oms.calicant.us/graphql/objects/accounting-sale-document.md): Permission required: accounting_document:read
- [AdyenDispute](https://docs.api.oms.calicant.us/graphql/objects/adyen-dispute.md): No description
- [AdyenTransaction](https://docs.api.oms.calicant.us/graphql/objects/adyen-transaction.md): No description
- [APIUser](https://docs.api.oms.calicant.us/graphql/objects/apiuser.md): Permission required: api_user:read
- [Billing](https://docs.api.oms.calicant.us/graphql/objects/billing.md): The billing address and fiscal data of an order. Permission required: billing:read
- [BrandConnection](https://docs.api.oms.calicant.us/graphql/objects/brand-connection.md): The connection type for Brand.
- [BrandEdge](https://docs.api.oms.calicant.us/graphql/objects/brand-edge.md): An edge in a connection.
- [Brand](https://docs.api.oms.calicant.us/graphql/objects/brand.md): Permission required: brand:read
- [Channel](https://docs.api.oms.calicant.us/graphql/objects/channel.md): Permission required: channel:read
- [DisputeConnection](https://docs.api.oms.calicant.us/graphql/objects/dispute-connection.md): The connection type for Dispute.
- [DisputeEdge](https://docs.api.oms.calicant.us/graphql/objects/dispute-edge.md): An edge in a connection.
- [FulfillmentLine](https://docs.api.oms.calicant.us/graphql/objects/fulfillment-line.md): A fulfilled quantity of a shipping line, as declared by the warehouse.
- [FulfillmentPacking](https://docs.api.oms.calicant.us/graphql/objects/fulfillment-packing.md): The packing declared by a warehouse when it confirmed the fulfilment of a shipping.
- [HeylightTransaction](https://docs.api.oms.calicant.us/graphql/objects/heylight-transaction.md): No description
- [NexiTransaction](https://docs.api.oms.calicant.us/graphql/objects/nexi-transaction.md): No description
- [OperationReturn](https://docs.api.oms.calicant.us/graphql/objects/operation-return.md): Generic return type for operations that have no intrinsic return type
- [OrderConnection](https://docs.api.oms.calicant.us/graphql/objects/order-connection.md): The connection type for Order.
- [OrderCustomerAction](https://docs.api.oms.calicant.us/graphql/objects/order-customer-action.md): Permission required: order_customer_action:read
- [OrderEdge](https://docs.api.oms.calicant.us/graphql/objects/order-edge.md): An edge in a connection.
- [OrderLine](https://docs.api.oms.calicant.us/graphql/objects/order-line.md): Permission required: order_line:read
- [Order](https://docs.api.oms.calicant.us/graphql/objects/order.md): Permission required: order:read
- [PageInfo](https://docs.api.oms.calicant.us/graphql/objects/page-info.md): Information about pagination in a connection.
- [PaymentBasicTransaction](https://docs.api.oms.calicant.us/graphql/objects/payment-basic-transaction.md): No description
- [PaymentExternalDisputeConnection](https://docs.api.oms.calicant.us/graphql/objects/payment-external-dispute-connection.md): The connection type for PaymentExternalDispute.
- [PaymentExternalDisputeEdge](https://docs.api.oms.calicant.us/graphql/objects/payment-external-dispute-edge.md): An edge in a connection.
- [PaymentExternalDispute](https://docs.api.oms.calicant.us/graphql/objects/payment-external-dispute.md): Permission required: payment_dispute:read
- [PaymentExternalTransactionConnection](https://docs.api.oms.calicant.us/graphql/objects/payment-external-transaction-connection.md): The connection type for PaymentExternalTransaction.
- [PaymentExternalTransactionEdge](https://docs.api.oms.calicant.us/graphql/objects/payment-external-transaction-edge.md): An edge in a connection.
- [PaymentExternalTransaction](https://docs.api.oms.calicant.us/graphql/objects/payment-external-transaction.md): Permission required: payment_transaction:read
- [PaymentGateway](https://docs.api.oms.calicant.us/graphql/objects/payment-gateway.md): No description
- [PaymentMerchantConnection](https://docs.api.oms.calicant.us/graphql/objects/payment-merchant-connection.md): The connection type for PaymentMerchant.
- [PaymentMerchantEdge](https://docs.api.oms.calicant.us/graphql/objects/payment-merchant-edge.md): An edge in a connection.
- [PaymentMerchant](https://docs.api.oms.calicant.us/graphql/objects/payment-merchant.md): Permission required: payment_merchant:read
- [PaymentTransactionFee](https://docs.api.oms.calicant.us/graphql/objects/payment-transaction-fee.md): No description
- [PaypalTransaction](https://docs.api.oms.calicant.us/graphql/objects/paypal-transaction.md): No description
- [ProductBundleAvailability](https://docs.api.oms.calicant.us/graphql/objects/product-bundle-availability.md): No description
- [ProductBundleConnection](https://docs.api.oms.calicant.us/graphql/objects/product-bundle-connection.md): The connection type for ProductBundle.
- [ProductBundleEdge](https://docs.api.oms.calicant.us/graphql/objects/product-bundle-edge.md): An edge in a connection.
- [ProductBundle](https://docs.api.oms.calicant.us/graphql/objects/product-bundle.md): Permission required: bundle:read
- [ProductComponent](https://docs.api.oms.calicant.us/graphql/objects/product-component.md): No description
- [ProductConnection](https://docs.api.oms.calicant.us/graphql/objects/product-connection.md): The connection type for Product.
- [ProductEdge](https://docs.api.oms.calicant.us/graphql/objects/product-edge.md): An edge in a connection.
- [ProductProductAvailability](https://docs.api.oms.calicant.us/graphql/objects/product-product-availability.md): No description
- [Product](https://docs.api.oms.calicant.us/graphql/objects/product.md): Permission required: product:read
- [RepaymentCausal](https://docs.api.oms.calicant.us/graphql/objects/repayment-causal.md): Permission required: repayment_causal:read
- [RepaymentLine](https://docs.api.oms.calicant.us/graphql/objects/repayment-line.md): Permission required: repayment_line:read
- [RepaymentRequestConnection](https://docs.api.oms.calicant.us/graphql/objects/repayment-request-connection.md): The connection type for RepaymentRequest.
- [RepaymentRequestEdge](https://docs.api.oms.calicant.us/graphql/objects/repayment-request-edge.md): An edge in a connection.
- [RepaymentRequest](https://docs.api.oms.calicant.us/graphql/objects/repayment-request.md): Permission required: repayment_request:read
- [RepaymentReturnedLine](https://docs.api.oms.calicant.us/graphql/objects/repayment-returned-line.md): A warehouse evaluation row of a return.
- [RepaymentShipping](https://docs.api.oms.calicant.us/graphql/objects/repayment-shipping.md): Permission required: repayment_shipping:read
- [ScalaPayTransaction](https://docs.api.oms.calicant.us/graphql/objects/scala-pay-transaction.md): No description
- [ShippingCarrier](https://docs.api.oms.calicant.us/graphql/objects/shipping-carrier.md): No description
- [ShippingEvent](https://docs.api.oms.calicant.us/graphql/objects/shipping-event.md): Permission required: shipping_event:read
- [ShippingLabel](https://docs.api.oms.calicant.us/graphql/objects/shipping-label.md): Permission required: shipping_label:read
- [ShippingLine](https://docs.api.oms.calicant.us/graphql/objects/shipping-line.md): No description
- [ShippingParcel](https://docs.api.oms.calicant.us/graphql/objects/shipping-parcel.md): No description
- [ShippingRatePrice](https://docs.api.oms.calicant.us/graphql/objects/shipping-rate-price.md): No description
- [ShippingRate](https://docs.api.oms.calicant.us/graphql/objects/shipping-rate.md): Permission required: shipping_rate:read
- [ShippingService](https://docs.api.oms.calicant.us/graphql/objects/shipping-service.md): No description
- [Shipping](https://docs.api.oms.calicant.us/graphql/objects/shipping.md): Permission required: shipping:read
- [ShopifyDispute](https://docs.api.oms.calicant.us/graphql/objects/shopify-dispute.md): No description
- [ShopifyTransaction](https://docs.api.oms.calicant.us/graphql/objects/shopify-transaction.md): No description
- [StockBatch](https://docs.api.oms.calicant.us/graphql/objects/stock-batch.md): A stock batch (lot) of a warehouse.
- [StripeTransaction](https://docs.api.oms.calicant.us/graphql/objects/stripe-transaction.md): No description
- [TransactionConnection](https://docs.api.oms.calicant.us/graphql/objects/transaction-connection.md): The connection type for Transaction.
- [TransactionEdge](https://docs.api.oms.calicant.us/graphql/objects/transaction-edge.md): An edge in a connection.
- [WarehouseConnection](https://docs.api.oms.calicant.us/graphql/objects/warehouse-connection.md): The connection type for Warehouse.
- [WarehouseEdge](https://docs.api.oms.calicant.us/graphql/objects/warehouse-edge.md): An edge in a connection.
- [Warehouse](https://docs.api.oms.calicant.us/graphql/objects/warehouse.md): Permission required: warehouse:read
- [Schema Documentation](https://docs.api.oms.calicant.us/public/graphql.md): This documentation has been automatically generated from the public GraphQL schema.
- [brand](https://docs.api.oms.calicant.us/graphql/queries/brand.md): Permission required: brand:query:brand
- [brands](https://docs.api.oms.calicant.us/graphql/queries/brands.md): Permission required: brand:query:brands
- [findBrand](https://docs.api.oms.calicant.us/graphql/queries/find-brand.md): Permission required: brand:query:find_brand
- [findLastOrder](https://docs.api.oms.calicant.us/graphql/queries/find-last-order.md): Permission required: order:query:find_last_order - Get an order by number, email, and channels
- [findOrders](https://docs.api.oms.calicant.us/graphql/queries/find-orders.md): Permission required: order:query:find_orders - Get all orders matching number, email, and channels
- [findWarehouse](https://docs.api.oms.calicant.us/graphql/queries/find-warehouse.md): Permission required: warehouse:query:find_warehouse
- [me](https://docs.api.oms.calicant.us/graphql/queries/me.md): Permission required: api_user:query:me - Gets the current user
- [order](https://docs.api.oms.calicant.us/graphql/queries/order.md): Permission required: order:query:order - Get an order by id
- [orders](https://docs.api.oms.calicant.us/graphql/queries/orders.md): Permission required: order:query:orders
- [paymentDispute](https://docs.api.oms.calicant.us/graphql/queries/payment-dispute.md): Permission required: payment_dispute:query:payment_dispute
- [paymentDisputes](https://docs.api.oms.calicant.us/graphql/queries/payment-disputes.md): Permission required: payment_dispute:query:payment_disputes
- [paymentExternalDispute](https://docs.api.oms.calicant.us/graphql/queries/payment-external-dispute.md): Permission required: payment_dispute:query:payment_external_dispute
- [paymentExternalDisputes](https://docs.api.oms.calicant.us/graphql/queries/payment-external-disputes.md): Permission required: payment_dispute:query:payment_external_disputes
- [paymentExternalTransaction](https://docs.api.oms.calicant.us/graphql/queries/payment-external-transaction.md): Permission required: payment_transaction:query:payment_external_transaction
- [paymentExternalTransactions](https://docs.api.oms.calicant.us/graphql/queries/payment-external-transactions.md): Permission required: payment_transaction:query:payment_external_transactions
- [paymentMerchant](https://docs.api.oms.calicant.us/graphql/queries/payment-merchant.md): Permission required: payment_merchant:query:payment_merchant
- [paymentMerchants](https://docs.api.oms.calicant.us/graphql/queries/payment-merchants.md): Permission required: payment_merchant:query:payment_merchants
- [paymentTransaction](https://docs.api.oms.calicant.us/graphql/queries/payment-transaction.md): Permission required: payment_transaction:query:payment_transaction
- [paymentTransactions](https://docs.api.oms.calicant.us/graphql/queries/payment-transactions.md): Permission required: payment_transaction:query:payment_transactions
- [repaymentRequest](https://docs.api.oms.calicant.us/graphql/queries/repayment-request.md): Permission required: repayment_request:query:repayment_request
- [repaymentRequests](https://docs.api.oms.calicant.us/graphql/queries/repayment-requests.md): Permission required: repayment_request:query:repayment_requests
- [shippingRates](https://docs.api.oms.calicant.us/graphql/queries/shipping-rates.md): Permission required: shipping_rate:query:shipping_rates
- [warehouse](https://docs.api.oms.calicant.us/graphql/queries/warehouse.md): Permission required: warehouse:query:warehouse
- [warehouses](https://docs.api.oms.calicant.us/graphql/queries/warehouses.md): Permission required: warehouse:query:warehouses
- [Boolean](https://docs.api.oms.calicant.us/graphql/scalars/boolean.md): The `Boolean` scalar type represents `true` or `false`.
- [Float](https://docs.api.oms.calicant.us/graphql/scalars/float.md): The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_f...
- [ID](https://docs.api.oms.calicant.us/graphql/scalars/id.md): The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response ...
- [Int](https://docs.api.oms.calicant.us/graphql/scalars/int.md): The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
- [ISO8601DateTime](https://docs.api.oms.calicant.us/graphql/scalars/iso8601-date-time.md): An ISO 8601-encoded datetime
- [String](https://docs.api.oms.calicant.us/graphql/scalars/string.md): The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to repres...