Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Store API
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
      GET
    • Get a Collection
      GET
  • Regions
    • List Regions
      GET
    • Get a Region
      GET
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Store API

Query Parameter Types

This section covers how to pass some common data types as query parameters.
This is useful if you're sending requests to the API endpoints and not using
our JS Client. For example, when using cURL or Postman.

Strings#

You can pass a string value in the form of <parameter_name>=<value>.
For example:
If the string has any characters other than letters and numbers, you must
encode them.
For example, if the string has spaces, you can encode the space with + or
%20:
You can use tools like this one to learn how
a value can be encoded.

Integers#

You can pass an integer value in the form of <parameter_name>=<value>.
For example:

Boolean#

You can pass a boolean value in the form of <parameter_name>=<value>.
For example:

Date and DateTime#

You can pass a date value in the form <parameter_name>=<value>. The date
must be in the format YYYY-MM-DD.
For example:
You can also pass the time using the format YYYY-MM-DDTHH:MM:SSZ. Please
note that the T and Z here are fixed.
For example:

Array#

Each array value must be passed as a separate query parameter in the form
<parameter_name>[]=<value>. You can also specify the index of each
parameter in the brackets <parameter_name>[0]=<value>.
For example:
Note that the -g parameter passed to curl disables errors being thrown
for using the brackets. Read more
here.

Object#

Object parameters must be passed as separate query parameters in the form
<parameter_name>[<key>]=<value>.
For example:
Modified at 2023-10-10 11:56:42
Previous
Selecting Fields
Next
Pagination
Built with