- Plugins
- Auth
- Draft Orders
- Create a Draft Order Edit
- Cancel Edit on Draft Order
- Confirm an Edit on a Draft Order
- Request Edit on Draft Order
- Convert a Draft Order to an Order
- Add Item to Draft Order Edit
- Update Existing Item in Draft Order Edit
- Remove Item from Draft Order Edit
- Update New Item in Draft Order Edit
- Add Promotions to Draft Order Edit
- Remove Promotions from Draft Order Edit
- Add Shipping Method to Draft Order Edit
- Remove Shipping Method from Draft Order Edit
- Update Existing Shipping Method in Draft Order Edit
- Remove New Shipping Method from Draft Order
- Update New Shipping Method in Draft Order Edit
- Delete a Draft Order
- Get a Draft Order
- Update a Draft Order
- Create Draft Order
- List Draft Orders
- Fulfillment Providers
- Fulfillment Sets
- Inventory Items
- Manage Inventory Levels
- Manage Inventory Levels of Inventory Item
- Create Inventory Level for Inventory Item
- List Inventory Levels
- Update an Inventory Level of an Inventory Item
- Remove Inventory Level of Inventory Item
- Create Inventory Item
- List Inventory Items
- Get a Inventory Item
- Delete Inventory Item
- Update an Inventory Item
- Order Edits
- Create Order Edit
- Confirm Order Edit
- Request Order Edit
- Add Items to Order Edit
- Update Order Item Quantity of Order Edit
- Remove Item from Order Edit
- Update an Item in an Order Edit
- Add Shipping Method to Order Edit
- Remove Shipping Method from Order Edit
- Update Shipping Method of an Order Edit
- Cancel Order Edit
- Orders
- List Changes on an Order
- Mark a Fulfillment as Delivered.
- Get Preview
- Archive an Order
- Cancel Order
- Cancel Transfer Request
- Create Credit Line for Order
- Request Order Transfer
- Complete Order
- Update Order
- Get an Order
- List Line Items
- Cancel Fulfillment
- Create an Order Fulfillment
- Create Shipment for an Order's Fulfillment
- List Orders
- Payment Collections
- Products
- Create Product Import
- Confirm Product Import
- Export Products
- Manage Products
- Manage Variants in a Product
- Associate Variant with Inventory Item
- Remove Inventory Item Association with Product Variant
- Update Product Variant's Inventory Details
- Delete a Product
- Get a Product
- Update a Product
- Create a Product Option
- List a Product's Options
- Get a Product's Option
- Delete an Option from Product
- Update a Product's Option
- Get Variant of a Product
- Delete Product Variant
- Update a Product Variant
- Manage Variants Inventory in a Product
- Create a Product Variant
- List Variants of a Product
- Create Product
- List Products
- Claims
- Get a Claim
- Cancel a Claim
- Add Inbound Items to a Claim
- Remove an Inbound Item from Claim
- Update Inbound Items of a Claim
- Add an Inbound Shipping Method to a Claim
- Cancel Claim Request
- Confirm a Claim Request
- Add Claim Items to a Claim
- Remove a Claim Item from a Claim
- Update a Claim Item
- Remove Inbound Shipping Method from Claim
- Update Inbound Shipping Method of a Claim
- Add Outbound Items to a Claim
- Remove an Outbound Item from Claim
- Update Outbound Item of a Claim
- Add Outbound Shipping Methods to a Claim
- Remove Outbound Shipping Method from Claim
- Update Outbound Shipping Method of a Claim
- Create a Claim
- List Claims
- Currencies
- Exchanges
- Get an Exchange
- Cancel an Exchange
- Add Inbound Items to an Exchange
- Remove Inbound Item from Exchange
- Update an Inbount Item of an Exchange
- Add an Inbound Shipping Method to an Exchange
- Cancel Exchange Request
- Confirm an Exchange
- Remove Inbound Shipping Method from Exchange
- Update Inbound Shipping Method of an Exchange
- Add Outbound Items to Exchange
- Remove Outbound Item from Exchange
- Update Outbound Item of an Exchange
- Add Outbound Shipping Method to Exchange
- Remove Outbound Shipping Method from Exchange
- Update Outbound Shipping Method of Exchange
- Create Exchange
- List Exchanges
- Fulfillments
- Invites
- Notifications
- Payments
- Returns
- Cancel a return.
- Get a Return
- Update a Return
- Add Damaged Items to Return
- Remove Damaged Item from Return
- Update Damaged Item of Return
- Add Received Items to Return
- Remove a Received Item from Return
- Update a Received Item in a Return
- Confirm Return Receival
- Add Requested Items to Return
- Remove Item from Return
- Update Requested Item in Return
- Add a Shipping Method to a Return
- Remove Shipping Method from Return
- Update a Shipping Method of a Return
- Start Return Receival
- Cancel Return Receival
- Confirm Return Request
- Cancel Return Request
- Create Return
- List Returns
- Users
- Workflows Executions
- Api Keys
- Price Lists
- Stores
- Tax Rates
- Price Preferences
- Return Reasons
- Sales Channels
- Stock Locations
- Tax Regions
- Promotions
- Customer Groups
- Product Tags
- Product Types
- Refund Reasons
- Uploads
- Campaigns
- Collections
- Customers
- Product Categories
- Reservations
- Shipping Profiles
- Regions
- Tax Providers
- Shipping Options
- Product Variants
- Schemas
- Schemas
- BaseCartAddress
- AdminApiKeyResponse
- AdminCampaignResponse
- AdminClaimOrderResponse
- AdminClaimPreviewResponse
- AdminClaimRequestResponse
- AdminClaimResponse
- AdminClaimReturnPreviewResponse
- AdminCollectionResponse
- AdminCurrencyResponse
- AdminCustomerAddressResponse
- AdminCustomerGroupResponse
- AdminCustomerResponse
- AdminDraftOrderPreviewResponse
- AdminDraftOrderResponse
- AdminExchangeOrderResponse
- AdminExchangePreviewResponse
- AdminExchangeRequestResponse
- AdminExchangeResponse
- AdminExchangeReturnResponse
- AdminFileResponse
- AdminFulfillmentResponse
- AdminFulfillmentSetResponse
- AdminInventoryItemResponse
- AdminInviteResponse
- AdminNotificationResponse
- AdminOrderEditPreviewResponse
- AdminOrderEditResponse
- AdminOrderPreviewResponse
- AdminOrderResponse
- AdminOrderReturnResponse
- AdminPaymentCollectionResponse
- AdminPaymentResponse
- AdminPriceListResponse
- AdminPricePreferenceResponse
- AdminProductCategoryResponse
- AdminProductOptionResponse
- AdminProductResponse
- AdminProductTagResponse
- AdminProductTypeResponse
- AdminProductVariantResponse
- AdminPromotionResponse
- AdminRegionResponse
- AdminReservationResponse
- AdminReturnPreviewResponse
- AdminReturnReasonResponse
- AdminReturnResponse
- AdminSalesChannelResponse
- AdminServiceZoneResponse
- AdminShippingOptionResponse
- AdminShippingProfileResponse
- AdminStockLocationResponse
- AdminStoreResponse
- AdminTaxRateResponse
- AdminTaxRegionResponse
- AdminUserResponse
- AdminWorkflowExecutionResponse
- AuthAdminSessionResponse
- AuthStoreSessionResponse
- RefundReasonResponse
- StoreCartResponse
- StoreCollectionResponse
- StoreCurrencyResponse
- StoreCustomerAddressResponse
- StoreCustomerResponse
- StoreOrderResponse
- StorePaymentCollectionResponse
- StoreProductCategoryResponse
- StoreProductResponse
- StoreProductTagResponse
- StoreProductTypeResponse
- StoreReturnReasonResponse
- StoreReturnResponse
- StoreShippingOptionResponse
- AdminCreateCustomerGroup
- AdminCreateProductTag
- AdminCreateProductType
- AdminCreateProductVariantInventoryKit
- AdminCreateRefundReason
- AdminCreateTaxRateRule
- AdminCreateVariantInventoryItem
- AdminCreateWorkflowsRun
- AdminExportProductResponse
- AdminFile
- AdminFileListResponse
- AdminFulfillmentProvider
- AdminFulfillmentProviderOption
- AdminOrderChangesResponse
- AdminPaymentProvider
- AdminPlugin
- AdminPluginsListResponse
- AdminPostCancelClaimReqSchema
- AdminPostCancelExchangeReqSchema
- AdminPostCancelReturnReqSchema
- AdminPostExchangesItemsActionReqSchema
- AdminPostReturnsConfirmRequestReqSchema
- AdminPostReturnsDismissItemsActionReqSchema
- AdminPostReturnsReceiveItemsActionReqSchema
- AdminProductVariantInventoryLinkDeleteResponse
- AdminRevokeApiKey
- AdminRuleValueOption
- AdminTaxProvider
- AdminTaxRateRule
- AdminUpdateApiKey
- AdminUpdateCustomerGroup
- AdminUpdateVariantInventoryItem
- AuthCallbackResponse
- AuthResponse
- BaseFulfillmentProvider
- BasePaymentProvider
- BasePromotionRuleValue
- StoreAcceptOrderTransfer
- StoreCreatePaymentCollection
- StoreCreateReturnShipping
- StoreDeclineOrderTransferRequest
- StorePaymentProvider
- StoreRequestOrderTransfer
- StoreShippingOptionListResponse
- StoreUpdateCartLineItem
- AdminBatchCreateInventoryItemsLocationLevels
- AdminClaimDeleteResponse
- AdminCollectionDeleteResponse
- AdminCreateOrderCreditLines
- AdminCreatePricePreference
- AdminCreateSalesChannel
- AdminCreateShippingOptionType
- AdminCreateShippingProfile
- AdminCreateStockLocation
- AdminDeletePaymentCollectionResponse
- AdminExchangeDeleteResponse
- AdminFulfillmentSetDeleteResponse
- AdminPostClaimsItemsActionReqSchema
- AdminPostClaimsShippingActionReqSchema
- AdminPostExchangesRequestItemsReturnActionReqSchema
- AdminPostExchangesShippingActionReqSchema
- AdminPostOrderEditsItemsActionReqSchema
- AdminPostOrderEditsReqSchema
- AdminPostOrderEditsShippingActionReqSchema
- AdminPostOrderEditsUpdateItemQuantityReqSchema
- AdminPostOrderExchangesReqSchema
- AdminPostReceiveReturnsReqSchema
- AdminPostReturnsRequestItemsActionReqSchema
- AdminPostReturnsReturnReqSchema
- AdminPostReturnsShippingActionReqSchema
- AdminPriceListDeleteResponse
- AdminPricePreferenceDeleteResponse
- AdminProductCategoryDeleteResponse
- AdminProductDeleteResponse
- AdminProductOptionDeleteResponse
- AdminProductTagDeleteResponse
- AdminProductTypeDeleteResponse
- AdminProductVariantDeleteResponse
- AdminProductVariantInventoryItemLink
- AdminReturnReasonDeleteResponse
- AdminRuleAttributeOption
- AdminSalesChannelDeleteResponse
- AdminServiceZoneDeleteResponse
- AdminShippingOptionDeleteResponse
- AdminShippingProfileDeleteResponse
- AdminStockLocationDeleteResponse
- AdminTaxRateDeleteResponse
- AdminTaxRegionDeleteResponse
- AdminTransferOrder
- AdminUpdateDraftOrderItem
- AdminUpdateDraftOrderShippingMethod
- AdminUpdatePricePreference
- AdminUpdateReturnReason
- AdminUpdateSalesChannel
- AdminUpdateUser
- AdminUserDeleteResponse
- BaseRuleOperatorOptions
- StoreAddCartLineItem
- StoreCreateReturnItem
- AdminAddDraftOrderPromotions
- AdminAddDraftOrderShippingMethod
- AdminBatchInventoryItemsLocationLevels
- AdminBatchInventoryItemsLocationLevelsResponse
- AdminBatchProductRequest
- AdminBatchProductVariantRequest
- AdminBatchUpdateInventoryItemsLocationLevels
- AdminClaimListResponse
- AdminCollectionListResponse
- AdminCreateApiKey
- AdminCreateProductOption
- AdminCreateReservation
- AdminCreateReturnReason
- AdminCreateWorkflowsAsyncResponse
- AdminCurrencyListResponse
- AdminDraftOrderListResponse
- AdminFulfillmentProviderListResponse
- AdminFulfillmentProviderOptionsListResponse
- AdminImportProductRequest
- AdminLinkPriceListProducts
- AdminNotificationListResponse
- AdminPostClaimsShippingReqSchema
- AdminPostExchangesShippingReqSchema
- AdminPostOrderEditsShippingReqSchema
- AdminPostReturnsReqSchema
- AdminPostReturnsShippingReqSchema
- AdminPriceListListResponse
- AdminPricePreferenceListResponse
- AdminProductCategoryListResponse
- AdminProductTag
- AdminProductTagListResponse
- AdminProductType
- AdminProductTypeListResponse
- AdminRefund
- AdminRefundReason
- AdminRegionCountry
- AdminRemoveDraftOrderPromotions
- AdminReturnReasonListResponse
- AdminStockLocation
- AdminStockLocationListResponse
- AdminStoreListResponse
- AdminUpdateDraftOrderActionShippingMethod
- AdminUpdateProductOption
- AdminUserListResponse
- BaseCapture
- BaseProductTag
- BaseProductType
- BaseRegionCountry
- RefundReason
- StoreCartAddPromotion
- StoreCartRemovePromotion
- StoreCreateCart
- StoreCreateCustomer
- StoreCreateReturn
- StoreCurrencyListResponse
- StoreCustomerAddressListResponse
- StoreInitializePaymentSession
- StorePrice
- StorePriceRule
- StoreProductCategoryListResponse
- StoreProductTag
- StoreProductTagListResponse
- StoreProductType
- StoreProductTypeListResponse
- StoreRegionCountry
- StoreUpdateCustomer
- AdminCollection
- AdminCreateProductCategory
- AdminCreateTaxRate
- AdminCustomerGroup
- AdminFulfillmentLabel
- AdminFulfillmentSet
- AdminInvite
- AdminPricePreference
- AdminProductImage
- AdminProductOptionValue
- AdminPromotionRule
- AdminReturnReason
- AdminSalesChannel
- AdminShippingOptionType
- AdminShippingProfile
- AdminStoreCurrency
- AdminUpdateTaxRegion
- AdminUpsertStockLocationAddress
- BaseCollection
- BaseExchangeItem
- BaseOrderShippingDetail
- BaseOrderSummary
- BaseProductImage
- BaseProductOptionValue
- BaseRefund
- Response Error
- InventoryLevel
- StoreCollection
- StoreProductImage
- StoreProductOptionValue
- StoreReturnReason
- StoreShippingOptionType
- AdminCreateRegion
- AdminCurrency
- AdminImportProductResponse
- AdminPostOrderClaimsReqSchema
- AdminProductOption
- AdminProductVariantInventoryLink
- AdminRegion
- AdminReturnItem
- AdminServiceZone
- AdminShippingOptionRule
- AdminStockLocationAddress
- AdminStore
- AdminUpdatePriceList
- AdminUser
- AdminWorkflowExecution
- ApiKeyResponse
- BaseOrderTransaction
- BaseProductOption
- BaseRegion
- OrderCreditLine
- StoreCurrency
- StoreProductOption
- StoreRegion
- StoreReturnItem
- UpdateCartData
- AdminApiKey
- AdminApplicationMethod
- AdminCreateProductVariantPrice
- AdminFulfillmentItem
- AdminInventoryLevel
- AdminPrice
- AdminPriceList
- AdminPromotion
- AdminReservation
- BaseLineItemAdjustment
- BaseLineItemTaxLine
- BaseOrderLineItemAdjustment
- BaseOrderLineItemTaxLine
- BaseOrderShippingMethodAdjustment
- BaseOrderShippingMethodTaxLine
- BaseShippingMethodAdjustment
- BaseShippingMethodTaxLine
- CreateAddress
- OrderLineItemAdjustment
- OrderLineItemTaxLine
- OrderReturnItem
- OrderShippingMethodAdjustment
- OrderShippingMethodTaxLine
- OrderTransaction
- AdminCreateInventoryItem
- AdminCreatePromotionRule
- AdminCreateShippingOptionRule
- AdminGeoZone
- AdminNotification
- AdminOrderChangeAction
- AdminOrderFulfillment
- AdminPaymentCollection
- AdminPaymentSession
- AdminPriceListPrice
- AdminShippingOptionPrice
- AdminTaxRate
- AdminTaxRegion
- AdminUpdatePromotionRule
- AdminUpdateShippingOptionRule
- BaseCalculatedPriceSet
- BaseOrderFulfillment
- BaseOrderItemDetail
- BasePaymentCollection
- BasePaymentSession
- OrderChangeAction
- OrderItem
- StoreCustomer
- StoreOrderFulfillment
- StorePaymentCollection
- StorePaymentSession
- StoreProductCategory
- StoreShippingOption
- UpdateAddress
- AdminBatchProductResponse
- AdminBatchProductVariantResponse
- AdminCreateShipment
- AdminCustomer
- AdminFulfillment
- AdminFulfillmentAddress
- AdminInventoryItem
- AdminOrderAddress
- AdminPayment
- AdminPostReturnsReceiveItemsReqSchema
- AdminPriceListBatchResponse
- BaseOrderAddress
- BasePayment
- OrderAddress
- StoreCalculatedPrice
- StoreCartAddress
- StoreCartPromotion
- StoreCartShippingOption
- StoreOrderAddress
- StoreReturn
- AdminBatchInventoryItemLocationsLevel
- AdminClaim
- AdminCreatePriceList
- AdminCreateTaxRegion
- AdminCustomerAddress
- AdminExchange
- AdminOrderItem
- AdminPostClaimsAddItemsReqSchema
- AdminPostExchangesAddItemsReqSchema
- AdminPostExchangesReturnRequestItemsReqSchema
- AdminPostReturnsRequestItemsReqSchema
- AdminReturn
- AdminShippingOption
- AdminShippingOptionPriceRule
- AdminUpdateStockLocation
- AdminUpdateTaxRate
- BaseProductCategory
- CampaignResponse
- OrderExchange
- StoreCustomerAddress
- AdminAddDraftOrderItems
- AdminBatchUpdateProductVariant
- AdminCreateProductVariant
- AdminPostClaimItemsReqSchema
- AdminPostOrderEditsAddItemsReqSchema
- AdminProductCategory
- AdminUpdateProductVariant
- AdminUpdateStore
- BaseClaimItem
- OrderClaim
- AdminCampaign
- AdminCreateShippingOption
- AdminOrderShippingMethod
- AdminUpdateOrder
- BaseCartShippingMethod
- BaseOrderShippingMethod
- OrderShippingMethod
- AdminOrderChange
- AdminUpdateDraftOrder
- BaseProductVariant
- OrderChange
- Return
- StoreProductVariant
- AdminProductVariant
- AdminCreateFulfillment
- AdminProduct
- AdminProductVariantInventoryBatchResponse
- WorkflowExecutionContext
- AdminUpdateProduct
- BaseCart
- BaseProduct
- StoreCart
- StoreProduct
- AdminBatchUpdateProduct
- AdminCreateProduct
- AdminWorkflowExecutionExecution
- BaseCartLineItem
- CustomerGroupInCustomerFilters
- StoreOrder
- AdminDraftOrder
- AdminOrder
- AdminOrderLineItem
- BaseOrder
- BaseOrderLineItem
- OrderLineItem
- StoreCartShippingMethod
- StoreCartLineItem
- Order
- AdminCustomerInGroupFilters
- StoreOrderShippingMethod
- AdminDraftOrderPreview
- AdminOrderPreview
- Response
CampaignResponse
{
"id": "string",
"name": "string",
"description": "string",
"currency": "string",
"campaign_identifier": "string",
"starts_at": "string",
"ends_at": "string",
"budget": {
"id": "string",
"currency_code": "string",
"limit": 0,
"used": 0,
"type": "spend"
}
}