This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
- Store API
- Admin API
- Auth
- Apps Oauth
- Batch Jobs
- Currencies
- Customers
- Customer Groups
- Products
- Discounts
- Draft Orders
- Gift Cards
- Inventory Items
- Invites
- Notes
- Notifications
- Orders
- Create a Reservation
- Cancel Claim's Fulfillment
- Ship a Claim's Fulfillment
- Cancel Swap's Fulfilmment
- Get Order Reservations
- Add a Shipping Method
- Create a Refund
- Get an Order
- Update an Order
- Create a Fulfillment
- Cancel a Swap
- List Orders
- Create a Swap
- Complete an Order
- Create a Swap Fulfillment
- Cancel a Claim
- Process a Swap Payment
- Ship a Fulfillment
- Capture an Order's Payments
- Archive Order
- Update a Claim
- Request a Return
- Create a Claim Fulfillment
- Ship a Swap's Fulfillment
- Cancel a Fulfilmment
- Create a Claim
- Cancel an Order
- Order Edits
- Payments
- Payment Collections
- Product Collections
- Product Tags
- Product Types
- Product Variants
- Price Lists
- Product Categories
- Publishable Api Keys
- Reservations
- Regions
- Return Reasons
- Returns
- Sales Channels
- Shipping Options
- Shipping Profiles
- Stock Locations
- Store
- Swaps
- Uploads
- Tax Rates
- Users
- dGET
- Schemas
- Store API
- Admin API
- Schemas
- AdminPostAppsReq
- AdminPostBatchesReq
- AdminPostAuthReq
- AdminPostCustomerGroupsGroupCustomersBatchReq
- AdminDeleteCustomerGroupsGroupCustomerBatchReq
- AdminPostCustomersReq
- AdminPostCollectionsReq
- AdminPostCollectionsCollectionReq
- AdminCollectionsDeleteRes
- AdminDeleteProductsFromCollectionRes
- AdminPostCurrenciesCurrencyReq
- AdminPostCustomerGroupsReq
- AdminPostProductsToCollectionReq
- AdminDeleteProductsFromCollectionReq
- AdminCustomerGroupsDeleteRes
- AdminPostCustomerGroupsGroupReq
- AdminPostDiscountsReq
- AdminPostCustomersCustomerReq
- AdminPostDiscountsDiscountReq
- AdminDiscountsDeleteRes
- AdminPostDiscountsDiscountConditionsCondition
- AdminPostDiscountsDiscountDynamicCodesReq
- AdminPostDiscountsDiscountConditions
- AdminPostDiscountsDiscountConditionsConditionBatchReq
- AdminDeleteDiscountsDiscountConditionsConditionBatchReq
- AdminDraftOrdersDeleteRes
- AdminPostDraftOrdersDraftOrderLineItemsItemReq
- AdminPostDraftOrdersDraftOrderLineItemsReq
- AdminInviteDeleteRes
- AdminPostNotesReq
- AdminPostNotesNoteReq
- AdminNotesDeleteRes
- AdminPostNotificationsNotificationResendReq
- AdminOrderEditDeleteRes
- AdminPostOrderEditsOrderEditReq
- AdminPostOrderEditsReq
- AdminPostInvitesInviteAcceptReq
- AdminPostOrdersOrderClaimsClaimReq
- AdminPostOrdersOrderFulfillmentsReq
- AdminPostOrdersOrderClaimsClaimFulfillmentsReq
- AdminPostReservationsReq
- AdminOrdersOrderLineItemReservationReq
- AdminPostOrdersOrderClaimsClaimShipmentsReq
- AdminPostOrdersOrderRefundsReq
- AdminPostInventoryItemsInventoryItemReq
- AdminPostGiftCardsReq
- AdminPostInventoryItemsItemLocationLevelsLevelReq
- AdminPostInventoryItemsReq
- AdminPostInventoryItemsItemLocationLevelsReq
- AdminPostInvitesReq
- AdminUpdatePaymentCollectionsReq
- AdminPaymentCollectionDeleteRes
- AdminPostPaymentRefundsReq
- AdminPostPriceListsPriceListReq
- AdminPostOrderEditsEditLineItemsLineItemReq
- AdminPostOrderEditsEditLineItemsReq
- AdminOrderEditItemChangeDeleteRes
- AdminPostOrdersOrderReturnsReq
- AdminPostOrdersOrderShipmentReq
- AdminInventoryItemsDeleteRes
- AdminPostOrdersOrderSwapsSwapShipmentsReq
- AdminPostGiftCardsGiftCardReq
- AdminGiftCardsDeleteRes
- AdminPostPriceListsPriceListPriceListReq
- AdminPostOrdersOrderShippingMethodsReq
- AdminPostOrdersOrderSwapsSwapFulfillmentsReq
- AdminPostOrdersOrderSwapsReq
- AdminPriceListDeleteRes
- AdminPostRegionsRegionCountriesReq
- AdminPriceListDeleteVariantPricesRes
- AdminPostProductCategoriesCategoryProductsBatchReq
- AdminDeleteProductCategoriesCategoryProductsBatchReq
- AdminPostProductCategoriesCategoryReq
- AdminProductCategoriesCategoryDeleteRes
- AdminPostRegionsRegionReq
- AdminRegionsDeleteRes
- AdminProductsListTagsRes
- AdminPostProductsProductOptionsOption
- AdminPostProductsProductMetadataReq
- AdminPostPublishableApiKeysPublishableApiKeyReq
- AdminPostProductsProductReq
- AdminPostRegionsRegionPaymentProvidersReq
- AdminPriceListDeleteBatchRes
- AdminDeletePriceListPricesPricesReq
- AdminPostPriceListPricesPricesReq
- AdminPostProductCategoriesReq
- AdminPostRegionsRegionFulfillmentProvidersReq
- AdminGetRegionsRegionFulfillmentOptionsRes
- AdminPriceListDeleteProductPricesRes
- AdminPostPublishableApiKeysReq
- AdminPostReservationsReservationReq
- AdminReservationsDeleteRes
- AdminPostProductsProductOptionsReq
- AdminProductsDeleteRes
- AdminPostRegionsReq
- AdminPostProductsReq
- AdminDeletePublishableApiKeySalesChannelsBatchReq
- AdminPostPublishableApiKeySalesChannelsBatchReq
- AdminPostProductsProductVariantsReq
- AdminPostProductsProductVariantsVariantReq
- AdminPostShippingOptionsReq
- AdminStockLocationsDeleteRes
- AdminUploadsRes
- AdminDeleteUploadsRes
- AdminBearerAuthRes
- AdminCreateUserRequest
- AdminPostUploadsDownloadUrlReq
- AdminPostTaxRatesTaxRateShippingOptionsReq
- AdminDeleteTaxRatesTaxRateShippingOptionsReq
- AdminPostSalesChannelsChannelProductsBatchReq
- AdminDeleteSalesChannelsChannelProductsBatchReq
- AdminPostSalesChannelsSalesChannelReq
- AdminSalesChannelsDeleteRes
- AdminPostSalesChannelsChannelStockLocationsReq
- AdminDeleteSalesChannelsChannelStockLocationsReq
- AdminSalesChannelsDeleteLocationRes
- AdminPublishableApiKeyDeleteRes
- Response Error
- AdminPostTaxRatesTaxRateReq
- AdminTaxRatesDeleteRes
- AdminPostTaxRatesTaxRateProductTypesReq
- AdminDeleteTaxRatesTaxRateProductTypesReq
- AdminPostTaxRatesTaxRateProductsReq
- AdminDeleteTaxRatesTaxRateProductsReq
- OAuth
- AdminAppsRes
- AdminResetPasswordRequest
- AdminUpdateUserRequest
- AdminDeleteUserRes
- User
- AdminAuthRes
- AdminPostTaxRatesReq
- AdminPostReturnReasonsReasonReq
- AdminReturnReasonsDeleteRes
- AdminPostReturnReasonsReq
- AdminPostReturnsReturnReceiveReq
- AdminPostSalesChannelsReq
- AdminPostShippingProfilesReq
- AdminDeleteShippingProfileRes
- AdminPostShippingProfilesProfileReq
- AdminPostShippingOptionsOptionReq
- AdminShippingOptionsDeleteRes
- AdminDeleteUploadsReq
- AdminResetPasswordTokenRequest
- AdminUploadsDownloadUrlRes
- AdminAppsListRes
- AdminPostStoreReq
- Product Collection
- AdminCollectionsListRes
- Customer Group
- AdminCustomerGroupsRes
- AdminCollectionsRes
- AdminCustomerGroupsListRes
- Currency
- AdminCurrenciesRes
- AdminCurrenciesListRes
- AddressPayload
- DraftOrder
- AdminDraftOrdersListRes
- AdminPostDraftOrdersReq
- AdminDraftOrdersRes
- AdminPostDraftOrdersDraftOrderReq
- AdminPostOrdersOrderClaimsReq
- Invite
- AdminListInvitesRes
- Refund
- AdminRefundRes
- InventoryLevelDTO
- AdminInventoryItemsLocationLevelsRes
- InventoryItemDTO
- AdminInventoryItemsRes
- Product Tag
- AdminProductTagsListRes
- Product Type
- AdminProductsListTypesRes
- AdminProductTypesListRes
- AdminPublishableApiKeysRes
- AdminPublishableApiKeysListRes
- Product Category
- AdminProductCategoriesListRes
- Reservation item
- AdminReservationsRes
- AdminProductCategoriesCategoryRes
- AdminUsersListRes
- AdminUserRes
- Batch Job
- AdminBatchJobListRes
- Shipping Profile
- AdminShippingProfilesListRes
- Return Reason
- AdminReturnReasonsRes
- Stock Location Address Input
- AdminPostStockLocationsReq
- AdminShippingProfilesRes
- AdminBatchJobRes
- AdminReturnReasonsListRes
- AdminPostStockLocationsLocationReq
- Payment Provider
- AdminPaymentProvidersList
- Tax Provider
- AdminTaxProvidersList
- Multiple Errors
- Discount Rule
- Note
- AdminNotesListRes
- AdminNotesRes
- Notification Provider
- Gift Card Transaction
- Payment
- AdminPaymentRes
- Line Item Tax Line
- Country
- Fulfillment Provider
- Image
- Product Variant Inventory Item
- Product Option Value
- Shipping Option Requirement
- Shipping Option
- AdminShippingOptionsListRes
- AdminShippingOptionsRes
- Sales Channel Stock Location
- Sales Channel
- AdminSalesChannelsRes
- AdminPublishableApiKeysListSalesChannelsRes
- AdminSalesChannelsListRes
- FeatureFlagsResponse
- ModulesResponse
- Address
- Customer
- AdminCustomersListRes
- AdminCustomersRes
- Shipping Method Tax Line
- Money Amount
- Price List
- AdminPriceListsListRes
- AdminPriceListRes
- Product Option
- Product Variant
- AdminProductsListVariantsRes
- ResponseInventoryItem
- VariantInventory
- AdminGetVariantsVariantInventoryRes
- Stock Location Address
- Stock Location
- StockLocationExpandedDTO
- AdminStockLocationsListRes
- AdminStockLocationsRes
- Store
- AdminStoresRes
- Notification
- AdminNotificationsListRes
- AdminNotificationsRes
- Shipping Method
- DecoratedInventoryItemDTO
- AdminInventoryItemsListWithVariantsAndLocationLevelsRes
- Product
- AdminPriceListsProductsListRes
- Priced Product Variant
- AdminVariantsRes
- AdminVariantsListRes
- ExtendedStoreDTO
- AdminExtendedStoresRes
- Discount Condition
- AdminDiscountConditionsRes
- Priced Product
- AdminProductsRes
- AdminProductsDeleteOptionRes
- AdminProductsListRes
- AdminProductsDeleteVariantRes
- Tax Rate
- AdminTaxRatesRes
- AdminTaxRatesListRes
- Region
- AdminRegionsRes
- AdminRegionsListRes
- Discount
- AdminDiscountsListRes
- AdminDiscountsRes
- AdminDiscountConditionsDeleteRes
- Gift Card
- AdminGiftCardsRes
- AdminGiftCardsListRes
- Line Item Adjustment
- Line Item
- AdminPostOrdersOrderReq
- Order
- AdminOrdersRes
- AdminOrdersListRes
- AdminPostDraftOrdersDraftOrderRegisterPaymentRes
- ExtendedReservationItem
- AdminReservationsListRes
- AdminReturnsCancelRes
- Swap
- AdminSwapsRes
- AdminSwapsListRes
- Order Item Change
- Return Item
- Return
- AdminReturnsListRes
- AdminReturnsRes
- Cart
- Payment Session
- Payment Collection
- AdminPaymentCollectionsRes
- Order Edit
- AdminOrderEditsRes
- AdminOrderEditsListRes
- Schemas
- StorePostSwapsReq
- StorePostCartReq
- StorePostCartsCartLineItemsItemReq
- StoreGetAuthEmailRes
- StorePostCartsCartShippingMethodReq
- StorePostCustomersCustomerOrderClaimReq
- StorePostCustomersCustomerAcceptClaimReq
- StorePostCustomersCustomerPasswordTokenReq
- StorePostOrderEditsOrderEditDecline
- StorePostCustomersResetPasswordReq
- StoreBearerAuthRes
- StorePostPaymentCollectionsBatchSessionsAuthorizeReq
- StorePostCustomersReq
- StorePostPaymentCollectionsBatchSessionsReq
- StorePostAuthReq
- StorePaymentCollectionSessionsReq
- StorePostCartsCartPaymentSessionReq
- StorePostCartsCartLineItemsReq
- StorePostSearchReq
- StoreCustomersListPaymentMethodsRes
- StorePostSearchRes
- Response Error
- Product Category
- StoreGetProductCategoriesCategoryRes
- StorePostCartsCartPaymentSessionUpdateReq
- StoreGetProductCategoriesRes
- Product Collection
- StoreCollectionsListRes
- Product Type
- StoreProductTypesListRes
- Return Reason
- StoreReturnReasonsListRes
- StoreReturnReasonsRes
- AddressPayload
- AddressCreatePayload
- StorePostCustomersCustomerAddressesReq
- StorePostCartsCartReq
- StorePostCustomersCustomerAddressesAddressReq
- StorePostCustomersCustomerReq
- Product Tag
- StoreProductTagsListRes
- StorePostReturnsReq
- Multiple Errors
- StoreCollectionsRes
- Fulfillment Provider
- Country
- Currency
- Payment Provider
- Tax Provider
- Customer Group
- Gift Card Transaction
- Address
- Customer
- StoreCustomersResetPasswordRes
- StoreCustomersRes
- StoreAuthRes
- Image
- Shipping Profile
- Product Variant Inventory Item
- Product Option Value
- Line Item Tax Line
- Shipping Method Tax Line
- Payment
- Money Amount
- Product Variant
- Priced Product Variant
- StoreVariantsRes
- Product Option
- StoreVariantsListRes
- Shipping Option Requirement
- Shipping Option
- Priced Shipping Option
- StoreCartShippingOptionsListRes
- StoreShippingOptionsListRes
- Shipping Method
- Discount Rule
- Sales Channel Stock Location
- Sales Channel
- Product
- Priced Product
- StoreProductsListRes
- StoreProductsRes
- Tax Rate
- Region
- StoreRegionsRes
- StoreRegionsListRes
- Gift Card
- StoreGiftCardsRes
- Discount
- Line Item Adjustment
- Line Item
- Swap
- StoreSwapsRes
- Cart
- StoreCartsRes
- Order
- StoreCustomersListOrdersRes
- StoreOrdersRes
- StoreCompleteCartRes
- Payment Session
- StorePaymentCollectionsSessionRes
- Payment Collection
- StorePaymentCollectionsRes
- Order Item Change
- Order Edit
- StoreOrderEditsRes
- Return Item
- Return
- StoreReturnsRes
AdminPostAuthReq
{
"email": "user@example.com",
"password": "pa$$word"
}