1. Customers
Medusa API
  • Store API
    • Getting Started
      • Introduction
      • Authentication
      • HTTP Compression
      • Publishable API Key
      • Expanding Fields
      • Selecting Fields
      • Query Parameter Types
      • Pagination
    • Auth
      • Check if Email Exists
      • Customer Login (JWT)
      • Customer Login (JWT)
      • Customer Log out
      • Get Current Customer
      • Customer Login
    • Carts
      • Create Payment Sessions
      • Update a Payment Session
      • Delete a Payment Session
      • Create a Cart
      • Get a Cart
      • Update a Cart
      • Remove Discount
      • Add a Line Item
      • Update a Line Item
      • Delete a Line Item
      • Select a Payment Session
      • Refresh a Payment Session
      • Add Shipping Method
      • Calculate Cart Taxes
      • Complete a Cart
    • Customers
      • Get Saved Payment Methods
        GET
      • Request Password Reset
        POST
      • Update a Shipping Address
        POST
      • Delete an Address
        DELETE
      • Create a Customer
        POST
      • Get a Customer
        GET
      • Update Customer
        POST
      • Add a Shipping Address
        POST
      • Reset Password
        POST
      • List Orders
        GET
    • Gift Cards
      • Get Gift Card by Code
    • Orders
      • Claim Order
      • Verify Order Claim
      • Look Up an Order
      • Get by Cart ID
      • Get an Order
    • Order Edits
      • Retrieve an Order Edit
      • Decline an Order Edit
      • Complete an Order Edit
    • Payment Collections
      • Refresh a Payment Session
      • Authorize Payment Session
      • Get a PaymentCollection
      • Create a Payment Session
      • Manage Payment Sessions
      • Authorize Payment Sessions
    • Products
      • Search Products
      • Get a Product
      • List Products
    • Product Variants
      • Get Product Variants
      • Get a Product Variant
    • Product Tags
      • List Product Tags
    • Product Categories
      • Get a Product Category
      • List Product Categories
    • Product Collections
      • List Collections
      • Get a Collection
    • Product Types
      • List Product Types
    • Regions
      • Get a Region
      • List Regions
    • Returns
      • Create Return
    • Return Reasons
      • List Return Reasons
      • Get a Return Reason
    • Shipping Options
      • List for Cart
      • Get Shipping Options
    • Swaps
      • Create a Swap
      • Get by Cart ID
  • Admin API
    • Auth
      • Get Current User
      • User Logout
      • User Login
      • User Login (JWT)
    • Apps Oauth
      • Generate Token for App
      • List Applications
    • Batch Jobs
      • Cancel a Batch Job
      • Get a Batch Job
      • Confirm a Batch Job
      • List Batch Jobs
      • Create a Batch Job
    • Currencies
      • List Currency
      • Update a Currency
    • Customers
      • Create a Customer
      • List Customers
      • Update a Customer
      • Get a Customer
    • Customer Groups
      • Remove Customers from Group
      • Add Customers to Group
      • List Customers
      • Create a Customer Group
      • List Customer Groups
      • Get a Customer Group
      • Delete a Customer Group
      • Update a Customer Group
    • Discounts
      • Create a Condition
      • Create a Discount
      • List Discounts
      • Get a Condition
      • Update a Condition
      • Delete a Condition
      • Create a Dynamic Code
      • Remove Batch Resources
      • Add Batch Resources
      • Get Discount by Code
      • Delete a Dynamic Code
      • Add Region to Discount
      • Remove Region
      • Delete a Discount
      • Update a Discount
      • Get a Discount
    • Draft Orders
      • Create a Line Item
      • Delete a Line Item
      • Update a Line Item
      • Update a Draft Order
      • Delete a Draft Order
      • Get a Draft Order
      • Create a Draft Order
      • List Draft Orders
      • Mark Paid
    • Gift Cards
      • Create a Gift Card
      • List Gift Cards
      • Delete a Gift Card
      • Get a Gift Card
      • Update a Gift Card
    • Inventory Items
      • Create an Inventory Item
      • List Inventory Items
      • List Inventory Level
      • Create an Location Level
      • Update an Inventory Item
      • Get an Inventory Item
      • Delete an Inventory Item
      • Update a Location Level
      • Delete a Location Level
    • Invites
      • Lists Invites
      • Create an Invite
      • Delete an Invite
      • Accept an Invite
      • Resend an Invite
    • Notes
      • List Notes
      • Create a Note
      • Get a Note
      • Delete a Note
      • Update a Note
    • Notifications
      • Resend Notification
      • List 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
      • Delete a Line Item Change
      • Add a Line Item
      • Upsert Line Item Change
      • Delete Line Item
      • Cancel an Order Edit
      • Delete an Order Edit
      • Get an Order Edit
      • Update an Order Edit
      • Request Confirmation
      • Create an OrderEdit
      • List Order Edits
      • Confirm an OrderEdit
    • Payments
      • Capture a Payment
      • Get Payment details
      • Refund Payment
    • Payment Collections
      • Delete a Payment Collection
      • Get a Payment Collection
      • Update Payment Collection
      • Mark Authorized
    • Product Collections
      • Add Products to Collection
      • Remove Products from Collection
      • Get a Collection
      • Update a Collection
      • Delete a Collection
      • List Collections
      • Create a Collection
    • Product Tags
      • List Product Tags
    • Product Types
      • List Product Types
    • Product Variants
      • Get Variant's Inventory
      • List Product Variants
      • Get a Product variant
    • Price Lists
      • Delete a Product's Prices
      • List Products
      • Delete a Variant's Prices
      • Get a Price List
      • Update a Price List
      • Delete a Price List
      • Add or Update Prices
      • Delete Prices
      • Create a Price List
      • List Price Lists
    • Products
      • List Product Types
      • List Tags Usage Number
      • List a Product's Variants
      • Create a Product Variant
      • Update a Product Variant
      • Delete a Product Variant
      • Add a Product Option
      • Set Metadata
      • Delete a Product Option
      • Update a Product Option
      • List Products
      • Create a Product
      • Delete a Product
      • Update a Product
      • Get a Product
    • Product Categories
      • Create a Product Category
      • List Product Categories
      • Update a Product Category
      • Delete a Product Category
      • Get a Product Category
      • Add Products to a Category
      • Remove Products from Category
    • Publishable Api Keys
      • List Sales Channels
      • Delete Publishable API Key
      • Get a Publishable API Key
      • Revoke a Publishable API Key
      • Remove Sales Channels
      • Add Sales Channels
      • Update Publishable API Key
      • List Publishable API keys
      • Create Publishable API Key
    • Reservations
      • Delete a Reservation
      • Update a Reservation
      • Get a Reservation
      • Create a Reservation
      • List Reservations
    • Regions
      • List Fulfillment Options
      • Add Country
      • Remove Fulfillment Provider
      • Remove Payment Provider
      • Add Payment Provider
      • Delete a Region
      • Update a Region
      • Get a Region
      • List Regions
      • Create a Region
      • Add Fulfillment Provider
      • Remove Country
    • Return Reasons
      • Get a Return Reason
      • Delete a Return Reason
      • Update a Return Reason
      • List Return Reasons
      • Create a Return Reason
    • Returns
      • Receive a Return
      • List Returns
      • Cancel a Return
    • Sales Channels
      • Remove Stock Location from Sales Channels.
      • Associate a Stock Location
      • Get a Sales Channel
      • Delete a Sales Channel
      • Update a Sales Channel
      • Remove Products from Sales Channel
      • Add Products to Sales Channel
      • Create a Sales Channel
      • List Sales Channels
    • Shipping Options
      • Update Shipping Option
      • Get a Shipping Option
      • Delete Shipping Option
      • List Shipping Options
      • Create Shipping Option
    • Shipping Profiles
      • List Shipping Profiles
      • Create a Shipping Profile
      • Delete a Shipping Profile
      • Update a Shipping Profile
      • Get a Shipping Profile
    • Stock Locations
      • List Stock Locations
      • Create a Stock Location
      • Get a Stock Location
      • Update a Stock Location
      • Delete a Stock Location
    • Store
      • List Payment Providers
      • Add a Currency Code
      • Remove a Currency
      • List Tax Providers
      • Update Store Details
      • Get Store details
    • Swaps
      • Get a Swap
      • List Swaps
    • Uploads
      • Upload Files
      • Delete an Uploaded File
      • Get a File's Download URL
      • Protected File Upload
    • Tax Rates
      • Add to Shipping Options
      • Remove Shipping Options from Rate
      • Create a Tax Rate
      • List Tax Rates
      • Add to Products
      • Remove Products from Rate
      • Delete a Tax Rate
      • Get a Tax Rate
      • Update a Tax Rate
      • Add to Product Types
      • Remove Product Types from Rate
    • Users
      • Reset Password
      • Request Password Reset
      • Get a User
      • Delete a User
      • Update a User
      • Create a User
      • List Users
  • Schemas
    • Store API
      • 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
    • 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
  1. Customers

List Orders

Prod Env
{{baseURL}}
Prod Env
{{baseURL}}
GET
/store/customers/me/orders
Retrieve a list of the logged-in Customer's Orders. The orders can be filtered by fields such as status or fulfillment_status. The orders can also be paginated.

Request

Query Params

Responses

🟢200OK
application/json
Body

🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl '{backend_url}/store/customers/me/orders' \
-H 'Authorization: Bearer {access_token}'
Response Response Example
200 - Example 1
Modified at 2025-07-23 05:41:28
Previous
Reset Password
Next
Get Gift Card by Code
Built with