asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
3a585cbdb3cd4d618b749ec2fc717b6a22687d7d
medusa-store/docs/api/store.oas.json
github-actions[bot] cce2b3827e chore(docs): Generated API Reference (#3935) 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-04-26 20:57:23 +03:00

15581 lines
517 KiB
JSON
Raw Blame History

{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Medusa Storefront API",
"description": "API reference for Medusa's Storefront endpoints. All endpoints are prefixed with `/store`.\n\n## Authentication\n\nTo send requests as an authenticated customer, you must use the Cookie Session ID.\n\n<!-- ReDoc-Inject: <SecurityDefinitions> -->\n\n## Expanding Fields\n\nIn many endpoints you'll find an `expand` query parameter that can be passed to the endpoint. You can use the `expand` query parameter to unpack an entity's relations and return them in the response.\n\nPlease note that the relations you pass to `expand` replace any relations that are expanded by default in the request.\n\n### Expanding One Relation\n\nFor example, when you retrieve a product, you can retrieve its collection by passing to the `expand` query parameter the value `collection`:\n\n```bash\ncurl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=collection\"\n```\n\n### Expanding Multiple Relations\n\nYou can expand more than one relation by separating the relations in the `expand` query parameter with a comma.\n\nFor example, to retrieve both the variants and the collection of a product, pass to the `expand` query parameter the value `variants,collection`:\n\n```bash\ncurl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand=variants,collection\"\n```\n\n### Prevent Expanding Relations\n\nSome requests expand relations by default. You can prevent that by passing an empty expand value to retrieve an entity without any extra relations.\n\nFor example:\n\n```bash\ncurl \"http://localhost:9000/store/products/prod_01GDJGP2XPQT2N3JHZQFMH5V45?expand\"\n```\n\nThis would retrieve the product with only its properties, without any relations like `collection`.\n\n## Selecting Fields\n\nIn many endpoints you'll find a `fields` query parameter that can be passed to the endpoint. You can use the `fields` query parameter to specify which fields in the entity should be returned in the response.\n\nPlease note that if you pass a `fields` query parameter, only the fields you pass in the value along with the `id` of the entity will be returned in the response.\n\nAlso, the `fields` query parameter does not affect the expanded relations. You'll have to use the `expand` parameter instead.\n\n### Selecting One Field\n\nFor example, when you retrieve a list of products, you can retrieve only the titles of the products by passing `title` as a value to the `fields` query parameter:\n\n```bash\ncurl \"http://localhost:9000/store/products?fields=title\"\n```\n\nAs mentioned above, the expanded relations such as `variants` will still be returned as they're not affected by the `fields` parameter.\n\nYou can ensure that only the `title` field is returned by passing an empty value to the `expand` query parameter. For example:\n\n```bash\ncurl \"http://localhost:9000/store/products?fields=title&expand\"\n```\n\n### Selecting Multiple Fields\n\nYou can pass more than one field by seperating the field names in the `fields` query parameter with a comma.\n\nFor example, to select the `title` and `handle` of a product:\n\n```bash\ncurl \"http://localhost:9000/store/products?fields=title,handle\"\n```\n\n### Retrieve Only the ID\n\nYou can pass an empty `fields` query parameter to return only the ID of an entity. For example:\n\n```bash\ncurl \"http://localhost:9000/store/products?fields\"\n```\n\nYou can also pair with an empty `expand` query parameter to ensure that the relations aren't retrieved as well. For example:\n\n```bash\ncurl \"http://localhost:9000/store/products?fields&expand\"\n```\n\n## Query Parameter Types\n\nThis 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.\n\n### Strings\n\nYou can pass a string value in the form of `<parameter_name>=<value>`.\n\nFor example:\n\n```bash\ncurl \"http://localhost:9000/store/products?title=Shirt\"\n```\n\nIf the string has any characters other than letters and numbers, you must encode them.\n\nFor example, if the string has spaces, you can encode the space with `+` or `%20`:\n\n```bash\ncurl \"http://localhost:9000/store/products?title=Blue%20Shirt\"\n```\n\nYou can use tools like [this one](https://www.urlencoder.org/) to learn how a value can be encoded.\n\n### Integers\n\nYou can pass an integer value in the form of `<parameter_name>=<value>`.\n\nFor example:\n\n```bash\ncurl \"http://localhost:9000/store/products?offset=1\"\n```\n\n### Boolean\n\nYou can pass a boolean value in the form of `<parameter_name>=<value>`.\n\nFor example:\n\n```bash\ncurl \"http://localhost:9000/store/products?is_giftcard=true\"\n```\n\n### Date and DateTime\n\nYou can pass a date value in the form `<parameter_name>=<value>`. The date must be in the format `YYYY-MM-DD`.\n\nFor example:\n\n```bash\ncurl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17\"\n```\n\nYou can also pass the time using the format `YYYY-MM-DDTHH:MM:SSZ`. Please note that the `T` and `Z` here are fixed.\n\nFor example:\n\n```bash\ncurl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17T07:22:30Z\"\n```\n\n### Array\n\nEach 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>`.\n\nFor example:\n\n```bash\ncurl -g \"http://localhost:9000/store/products?sales_channel_id[]=sc_01GPGVB42PZ7N3YQEP2WDM7PC7&sales_channel_id[]=sc_234PGVB42PZ7N3YQEP2WDM7PC7\"\n```\n\nNote that the `-g` parameter passed to `curl` disables errors being thrown for using the brackets. Read more [here](https://curl.se/docs/manpage.html#-g).\n\n### Object\n\nObject parameters must be passed as separate query parameters in the form `<parameter_name>[<key>]=<value>`.\n\nFor example:\n\n```bash\ncurl -g \"http://localhost:9000/store/products?created_at[lt]=2023-02-17&created_at[gt]=2022-09-17\"\n```\n\n## Pagination\n\n### Query Parameters\n\nIn listing endpoints, such as list customers or list products, you can control the pagination using the query parameters `limit` and `offset`.\n\n`limit` is used to specify the maximum number of items that can be return in the response. `offset` is used to specify how many items to skip before returning the resulting entities.\n\nYou can use the `offset` query parameter to change between pages. For example, if the limit is 50, at page 1 the offset should be 0; at page 2 the offset should be 50, and so on.\n\nFor example, to limit the number of products returned in the List Products endpoint:\n\n```bash\ncurl \"http://localhost:9000/store/products?limit=5\"\n```\n\n### Response Fields\n\nIn the response of listing endpoints, aside from the entities retrieved, there are three pagination-related fields returned: `count`, `limit`, and `offset`.\n\nSimilar to the query parameters, `limit` is the maximum number of items that can be returned in the response, and `field` is the number of items that were skipped before the entities in the result.\n\n`count` is the total number of available items of this entity. It can be used to determine how many pages are there.\n\nFor example, if the `count` is 100 and the `limit` is 50, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`.\n\n### Sort Order\n\nThe `order` field available on endpoints supporting pagination allows you to sort the retrieved items by an attribute of that item. For example, you can sort products by their `created_at` attribute by setting `order` to `created_at`:\n\n```bash\ncurl \"http://localhost:9000/list/products?order=created_at\"\n```\n\nBy default, the sort direction will be ascending. To change it to descending, pass a dash (`-`) before the attribute name. For example:\n\n```bash\ncurl \"http://localhost:9000/list/products?order=-created_at\"\n```\n\nThis sorts the products by their `created_at` attribute in the descending order.\n",
"license": {
"name": "MIT",
"url": "https://github.com/medusajs/medusa/blob/master/LICENSE"
}
},
"tags": [
{
"name": "Auth",
"description": "Auth endpoints that allow authorization of customers and manages their sessions."
},
{
"name": "Carts",
"description": "Cart endpoints that allow handling carts in Medusa."
},
{
"name": "Collections",
"description": "Collection endpoints that allow handling collections in Medusa."
},
{
"name": "Customers",
"description": "Customer endpoints that allow handling customers in Medusa."
},
{
"name": "Gift Cards",
"description": "Gift Card endpoints that allow handling gift cards in Medusa."
},
{
"name": "Orders",
"description": "Order endpoints that allow handling orders in Medusa."
},
{
"name": "Products",
"description": "Product endpoints that allow handling products in Medusa."
},
{
"name": "Product Variants",
"description": "Product Variant endpoints that allow handling product variants in Medusa."
},
{
"name": "Regions",
"description": "Region endpoints that allow handling regions in Medusa."
},
{
"name": "Return Reasons",
"description": "Return Reason endpoints that allow handling return reasons in Medusa."
},
{
"name": "Returns",
"description": "Return endpoints that allow handling returns in Medusa."
},
{
"name": "Shipping Options",
"description": "Shipping Option endpoints that allow handling shipping options in Medusa."
},
{
"name": "Swaps",
"description": "Swap endpoints that allow handling swaps in Medusa."
}
],
"servers": [
{
"url": "https://api.medusa-commerce.com"
}
],
"paths": {
"/store/auth": {
"get": {
"operationId": "GetAuth",
"summary": "Get Current Customer",
"description": "Gets the currently logged in Customer.",
"x-authenticated": true,
"x-codegen": {
"method": "getSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.auth.getSession()\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/auth' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Auth"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreAuthRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"post": {
"operationId": "PostAuth",
"summary": "Customer Login",
"description": "Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostAuthReq"
}
}
}
},
"x-codegen": {
"method": "authenticate"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.auth.authenticate({\n email: 'user@example.com',\n password: 'user@example.com'\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/auth' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"user@example.com\",\n \"password\": \"supersecret\"\n}'\n"
}
],
"tags": [
"Auth"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreAuthRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/incorrect_credentials"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"delete": {
"operationId": "DeleteAuth",
"summary": "Customer Log out",
"description": "Destroys a Customer's authenticated session.",
"x-authenticated": true,
"x-codegen": {
"method": "deleteSession"
},
"x-codeSamples": [
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/store/auth' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Auth"
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/auth/{email}": {
"get": {
"operationId": "GetAuthEmail",
"summary": "Check if email exists",
"description": "Checks if a Customer with the given email has signed up.",
"parameters": [
{
"in": "path",
"name": "email",
"schema": {
"type": "string",
"format": "email"
},
"required": true,
"description": "The email to check if exists."
}
],
"x-codegen": {
"method": "exists"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.auth.exists('user@example.com')\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/auth/user@example.com' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"tags": [
"Auth"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGetAuthEmailRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts": {
"post": {
"summary": "Create a Cart",
"operationId": "PostCart",
"description": "Creates a Cart within the given region and with the initial items. If no `region_id` is provided the cart will be associated with the first Region available. If no items are provided the cart will be empty after creation. If a user is logged in the cart's customer id and email will be set.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartReq"
}
}
}
},
"x-codegen": {
"method": "create"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.create()\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "Successfully created a new Cart",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}": {
"get": {
"operationId": "GetCartsCart",
"summary": "Get a Cart",
"description": "Retrieves a Cart.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.retrieve(cart_id)\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/carts/{id}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"post": {
"operationId": "PostCartsCart",
"summary": "Update a Cart",
"description": "Updates a Cart.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartReq"
}
}
}
},
"x-codegen": {
"method": "update"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.update(cart_id, {\n email: 'user@example.com'\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"user@example.com\"\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/complete": {
"post": {
"summary": "Complete a Cart",
"operationId": "PostCartsCartComplete",
"description": "Completes a cart. The following steps will be performed. Payment authorization is attempted and if more work is required, we simply return the cart for further updates. If payment is authorized and order is not yet created, we make sure to do so. The completion of a cart can be performed idempotently with a provided header `Idempotency-Key`. If not provided, we will generate one for the request.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The Cart id.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "complete"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.complete(cart_id)\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/complete'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "If a cart was successfully authorized, but requires further action from the user the response body will contain the cart with an updated payment session. If the Cart was successfully completed the response body will contain the newly created Order.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCompleteCartRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/discounts/{code}": {
"delete": {
"operationId": "DeleteCartsCartDiscountsDiscount",
"description": "Removes a Discount from a Cart.",
"summary": "Remove Discount",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "code",
"required": true,
"description": "The unique Discount code.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "deleteDiscount"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.deleteDiscount(cart_id, code)\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/discounts/{code}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/line-items": {
"post": {
"operationId": "PostCartsCartLineItems",
"summary": "Add a Line Item",
"description": "Generates a Line Item with a given Product Variant and adds it to the Cart",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart to add the Line Item to.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartLineItemsReq"
}
}
}
},
"x-codegen": {
"method": "createLineItem"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.lineItems.create(cart_id, {\n variant_id,\n quantity: 1\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"variant_id\": \"{variant_id}\",\n \"quantity\": 1\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/line-items/{line_id}": {
"post": {
"operationId": "PostCartsCartLineItemsItem",
"summary": "Update a Line Item",
"description": "Updates a Line Item if the desired quantity can be fulfilled.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "line_id",
"required": true,
"description": "The id of the Line Item.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartLineItemsItemReq"
}
}
}
},
"x-codegen": {
"method": "updateLineItem"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.lineItems.update(cart_id, line_id, {\n quantity: 1\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"quantity\": 1\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"delete": {
"operationId": "DeleteCartsCartLineItemsItem",
"summary": "Delete a Line Item",
"description": "Removes a Line Item from a Cart.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "line_id",
"required": true,
"description": "The id of the Line Item.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "deleteLineItem"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.lineItems.delete(cart_id, line_id)\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/line-items/{line_id}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/payment-session": {
"post": {
"operationId": "PostCartsCartPaymentSession",
"summary": "Select a Payment Session",
"description": "Selects a Payment Session as the session intended to be used towards the completion of the Cart.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Cart.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartPaymentSessionReq"
}
}
}
},
"x-codegen": {
"method": "setPaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.setPaymentSession(cart_id, {\n provider_id: 'manual'\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"provider_id\": \"manual\"\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/payment-sessions": {
"post": {
"operationId": "PostCartsCartPaymentSessions",
"summary": "Create Payment Sessions",
"description": "Creates Payment Sessions for each of the available Payment Providers in the Cart's Region.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "createPaymentSessions"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.createPaymentSessions(cart_id)\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/payment-sessions/{provider_id}": {
"post": {
"operationId": "PostCartsCartPaymentSessionUpdate",
"summary": "Update a Payment Session",
"description": "Updates a Payment Session with additional data.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "provider_id",
"required": true,
"description": "The id of the payment provider.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartPaymentSessionUpdateReq"
}
}
}
},
"x-codegen": {
"method": "updatePaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.updatePaymentSession(cart_id, 'manual', {\n data: {\n\n }\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"data\": {}\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"delete": {
"operationId": "DeleteCartsCartPaymentSessionsSession",
"summary": "Delete a Payment Session",
"description": "Deletes a Payment Session on a Cart. May be useful if a payment has failed.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "provider_id",
"required": true,
"description": "The id of the Payment Provider used to create the Payment Session to be deleted.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "deletePaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.deletePaymentSession(cart_id, 'manual')\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/payment-sessions/{provider_id}/refresh": {
"post": {
"operationId": "PostCartsCartPaymentSessionsSession",
"summary": "Refresh a Payment Session",
"description": "Refreshes a Payment Session to ensure that it is in sync with the Cart - this is usually not necessary.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "provider_id",
"required": true,
"description": "The id of the Payment Provider that created the Payment Session to be refreshed.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "refreshPaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.refreshPaymentSession(cart_id, 'manual')\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/payment-sessions/manual/refresh'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/shipping-methods": {
"post": {
"operationId": "PostCartsCartShippingMethod",
"description": "Adds a Shipping Method to the Cart.",
"summary": "Add a Shipping Method",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The cart ID.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCartsCartShippingMethodReq"
}
}
}
},
"x-codegen": {
"method": "addShippingMethod"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.carts.addShippingMethod(cart_id, {\n option_id\n})\n.then(({ cart }) => {\n console.log(cart.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/shipping-methods' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"option_id\": \"{option_id}\",\n}'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/carts/{id}/taxes": {
"post": {
"summary": "Calculate Cart Taxes",
"operationId": "PostCartsCartTaxes",
"description": "Calculates taxes for a cart. Depending on the cart's region this may involve making 3rd party API calls to a Tax Provider service.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The Cart ID.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "calculateTaxes"
},
"x-codeSamples": [
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/carts/{id}/taxes'\n"
}
],
"tags": [
"Carts"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/collections": {
"get": {
"operationId": "GetCollections",
"summary": "List Collections",
"description": "Retrieve a list of Product Collection.",
"parameters": [
{
"in": "query",
"name": "offset",
"description": "The number of collections to skip before starting to collect the collections set",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "limit",
"description": "The number of collections to return",
"schema": {
"type": "integer",
"default": 10
}
},
{
"in": "query",
"name": "handle",
"style": "form",
"explode": false,
"description": "Filter by the collection handle",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting collections were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting collections were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetCollectionsParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.collections.list()\n.then(({ collections, limit, offset, count }) => {\n console.log(collections.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/collections'\n"
}
],
"tags": [
"Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/collections/{id}": {
"get": {
"operationId": "GetCollectionsCollection",
"summary": "Get a Collection",
"description": "Retrieves a Product Collection.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Product Collection",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.collections.retrieve(collection_id)\n.then(({ collection }) => {\n console.log(collection.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/collections/{id}'\n"
}
],
"tags": [
"Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCollectionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers": {
"post": {
"operationId": "PostCustomers",
"summary": "Create a Customer",
"description": "Creates a Customer account.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersReq"
}
}
}
},
"x-codegen": {
"method": "create"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.customers.create({\n first_name: 'Alec',\n last_name: 'Reynolds',\n email: 'user@example.com',\n password: 'supersecret'\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"first_name\": \"Alec\",\n \"last_name\": \"Reynolds\",\n \"email\": \"user@example.com\",\n \"password\": \"supersecret\"\n}'\n"
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"description": "A customer with the same email exists",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The error code"
},
"type": {
"type": "string",
"description": "The type of error"
},
"message": {
"type": "string",
"description": "Human-readable message with details about the error"
}
}
},
"example": {
"code": "invalid_request_error",
"type": "duplicate_error",
"message": "A customer with the given email already has an account. Log in instead"
}
}
}
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/me": {
"get": {
"operationId": "GetCustomersCustomer",
"summary": "Get a Customer",
"description": "Retrieves a Customer - the Customer must be logged in to retrieve their details.",
"x-authenticated": true,
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.retrieve()\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/customers/me' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"post": {
"operationId": "PostCustomersCustomer",
"summary": "Update Customer",
"description": "Updates a Customer's saved details.",
"x-authenticated": true,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerReq"
}
}
}
},
"x-codegen": {
"method": "update"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.update({\n first_name: 'Laury'\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers/me' \\\n--header 'Cookie: connect.sid={sid}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"first_name\": \"Laury\"\n}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/me/addresses": {
"post": {
"operationId": "PostCustomersCustomerAddresses",
"summary": "Add a Shipping Address",
"description": "Adds a Shipping Address to a Customer's saved addresses.",
"x-authenticated": true,
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerAddressesReq"
}
}
}
},
"x-codegen": {
"method": "addAddress"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.addresses.addAddress({\n address: {\n first_name: 'Celia',\n last_name: 'Schumm',\n address_1: '225 Bednar Curve',\n city: 'Danielville',\n country_code: 'US',\n postal_code: '85137',\n phone: '981-596-6748 x90188',\n company: 'Wyman LLC',\n address_2: '',\n province: 'Georgia',\n metadata: {}\n }\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses' \\\n--header 'Cookie: connect.sid={sid}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"address\": {\n \"first_name\": \"Celia\",\n \"last_name\": \"Schumm\",\n \"address_1\": \"225 Bednar Curve\",\n \"city\": \"Danielville\",\n \"country_code\": \"US\",\n \"postal_code\": \"85137\"\n }\n}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "A successful response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/me/addresses/{address_id}": {
"post": {
"operationId": "PostCustomersCustomerAddressesAddress",
"summary": "Update a Shipping Address",
"description": "Updates a Customer's saved Shipping Address.",
"x-authenticated": true,
"parameters": [
{
"in": "path",
"name": "address_id",
"required": true,
"description": "The id of the Address to update.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerAddressesAddressReq"
}
}
}
},
"x-codegen": {
"method": "updateAddress"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.addresses.updateAddress(address_id, {\n first_name: 'Gina'\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \\\n--header 'Cookie: connect.sid={sid}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"first_name\": \"Gina\"\n}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
},
"delete": {
"operationId": "DeleteCustomersCustomerAddressesAddress",
"summary": "Delete an Address",
"description": "Removes an Address from the Customer's saved addresses.",
"x-authenticated": true,
"parameters": [
{
"in": "path",
"name": "address_id",
"required": true,
"description": "The id of the Address to remove.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "deleteAddress"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.addresses.deleteAddress(address_id)\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request DELETE 'https://medusa-url.com/store/customers/me/addresses/{address_id}' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/me/orders": {
"get": {
"operationId": "GetCustomersCustomerOrders",
"summary": "List Orders",
"description": "Retrieves a list of a Customer's Orders.",
"x-authenticated": true,
"parameters": [
{
"in": "query",
"name": "q",
"description": "Query used for searching orders.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "id",
"description": "Id of the order to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "status",
"style": "form",
"explode": false,
"description": "Status to search for.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "fulfillment_status",
"style": "form",
"explode": false,
"description": "Fulfillment status to search for.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "payment_status",
"style": "form",
"explode": false,
"description": "Payment status to search for.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "display_id",
"description": "Display id to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cart_id",
"description": "to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "email",
"description": "to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "currency_code",
"style": "form",
"explode": false,
"description": "The 3 character ISO currency code to set prices based on.",
"schema": {
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
}
},
{
"in": "query",
"name": "tax_rate",
"description": "to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting collections were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting collections were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "canceled_at",
"description": "Date comparison for when resulting collections were canceled.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "limit",
"description": "How many orders to return.",
"schema": {
"type": "integer",
"default": 10
}
},
{
"in": "query",
"name": "offset",
"description": "The offset in the resulting orders.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated string) Which fields should be included in the resulting orders.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated string) Which relations should be expanded in the resulting orders.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "listOrders",
"queryParams": "StoreGetCustomersCustomerOrdersParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.listOrders()\n.then(({ orders, limit, offset, count }) => {\n console.log(orders);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersListOrdersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/me/payment-methods": {
"get": {
"operationId": "GetCustomersCustomerPaymentMethods",
"summary": "Get Payment Methods",
"description": "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods.",
"x-authenticated": true,
"x-codegen": {
"method": "listPaymentMethods"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged\nmedusa.customers.paymentMethods.list()\n.then(({ payment_methods }) => {\n console.log(payment_methods.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/customers/me/payment-methods' \\\n--header 'Cookie: connect.sid={sid}'\n"
}
],
"security": [
{
"cookie_auth": []
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersListPaymentMethodsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/password-reset": {
"post": {
"operationId": "PostCustomersResetPassword",
"summary": "Reset Password",
"description": "Resets a Customer's password using a password token created by a previous /password-token request.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersResetPasswordReq"
}
}
}
},
"x-codegen": {
"method": "resetPassword"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.customers.resetPassword({\n email: 'user@example.com',\n password: 'supersecret',\n token: 'supersecrettoken'\n})\n.then(({ customer }) => {\n console.log(customer.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers/password-reset' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"user@example.com\",\n \"password\": \"supersecret\",\n \"token\": \"supersecrettoken\"\n}'\n"
}
],
"tags": [
"Customers"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCustomersResetPasswordRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/customers/password-token": {
"post": {
"operationId": "PostCustomersCustomerPasswordToken",
"summary": "Request Password Reset",
"description": "Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerPasswordTokenReq"
}
}
}
},
"x-codegen": {
"method": "generatePasswordToken"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.customers.generatePasswordToken({\n email: 'user@example.com'\n})\n.then(() => {\n // successful\n})\n.catch(() => {\n // failed\n})\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/customers/password-token' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"user@example.com\"\n}'\n"
}
],
"tags": [
"Customers"
],
"responses": {
"204": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/gift-cards/{code}": {
"get": {
"operationId": "GetGiftCardsCode",
"summary": "Get Gift Card by Code",
"description": "Retrieves a Gift Card by its associated unique code.",
"parameters": [
{
"in": "path",
"name": "code",
"required": true,
"description": "The unique Gift Card code.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.giftCards.retrieve(code)\n.then(({ gift_card }) => {\n console.log(gift_card.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/gift-cards/{code}'\n"
}
],
"tags": [
"Gift Cards"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGiftCardsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/order-edits/{id}": {
"get": {
"operationId": "GetOrderEditsOrderEdit",
"summary": "Retrieve an OrderEdit",
"description": "Retrieves a OrderEdit.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the OrderEdit.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orderEdits.retrieve(order_edit_id)\n.then(({ order_edit }) => {\n console.log(order_edit.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/order-edits/{id}'\n"
}
],
"tags": [
"Order Edits"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrderEditsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/order-edits/{id}/complete": {
"post": {
"operationId": "PostOrderEditsOrderEditComplete",
"summary": "Completes an OrderEdit",
"description": "Completes an OrderEdit.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Order Edit.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "complete"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orderEdits.complete(order_edit_id)\n .then(({ order_edit }) => {\n console.log(order_edit.id)\n })\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/complete'\n"
}
],
"tags": [
"Order Edits"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrderEditsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/order-edits/{id}/decline": {
"post": {
"operationId": "PostOrderEditsOrderEditDecline",
"summary": "Decline an OrderEdit",
"description": "Declines an OrderEdit.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the OrderEdit.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostOrderEditsOrderEditDecline"
}
}
}
},
"x-codegen": {
"method": "decline"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orderEdits.decline(order_edit_id)\n .then(({ order_edit }) => {\n console.log(order_edit.id);\n })\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/decline'\n"
}
],
"tags": [
"Order Edits"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrderEditsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/orders": {
"get": {
"operationId": "GetOrders",
"summary": "Look Up an Order",
"description": "Look up an order using filters.",
"parameters": [
{
"in": "query",
"name": "display_id",
"required": true,
"description": "The display id given to the Order.",
"schema": {
"type": "number"
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated) Which fields should be included in the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated) Which fields should be expanded in the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "email",
"style": "form",
"explode": false,
"description": "The email associated with this order.",
"required": true,
"schema": {
"type": "string",
"format": "email"
}
},
{
"in": "query",
"name": "shipping_address",
"style": "form",
"explode": false,
"description": "The shipping address associated with this order.",
"schema": {
"type": "object",
"properties": {
"postal_code": {
"type": "string",
"description": "The postal code of the shipping address"
}
}
}
}
],
"x-codegen": {
"method": "lookupOrder",
"queryParams": "StoreGetOrdersParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orders.lookupOrder({\n display_id: 1,\n email: 'user@example.com'\n})\n.then(({ order }) => {\n console.log(order.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/orders?display_id=1&email=user@example.com'\n"
}
],
"tags": [
"Orders"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrdersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/orders/batch/customer/token": {
"post": {
"operationId": "PostOrdersCustomerOrderClaim",
"summary": "Claim an Order",
"description": "Sends an email to emails registered to orders provided with link to transfer order ownership",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerOrderClaimReq"
}
}
}
},
"x-codegen": {
"method": "requestCustomerOrders"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.orders.claimOrders({\n display_ids,\n})\n.then(() => {\n // successful\n})\n.catch(() => {\n // an error occurred\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/batch/customer/token' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"display_ids\": [\"id\"],\n}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Orders"
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/orders/cart/{cart_id}": {
"get": {
"operationId": "GetOrdersOrderCartId",
"summary": "Get by Cart ID",
"description": "Retrieves an Order by the id of the Cart that was used to create the Order.",
"parameters": [
{
"in": "path",
"name": "cart_id",
"required": true,
"description": "The ID of Cart.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieveByCartId"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orders.retrieveByCartId(cart_id)\n.then(({ order }) => {\n console.log(order.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/orders/cart/{id}'\n"
}
],
"tags": [
"Orders"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrdersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/orders/customer/confirm": {
"post": {
"operationId": "PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept",
"summary": "Verify an Order Claim",
"description": "Verifies the claim order token provided to the customer upon request of order ownership",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostCustomersCustomerAcceptClaimReq"
}
}
}
},
"x-codegen": {
"method": "confirmRequest"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.orders.confirmRequest(\n token,\n)\n.then(() => {\n // successful\n})\n.catch(() => {\n // an error occurred\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/orders/customer/confirm' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"token\": \"{token}\",\n}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Orders"
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/orders/{id}": {
"get": {
"operationId": "GetOrdersOrder",
"summary": "Get an Order",
"description": "Retrieves an Order",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Order.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated) Which fields should be included in the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated) Which fields should be expanded in the result.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.orders.retrieve(order_id)\n.then(({ order }) => {\n console.log(order.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/orders/{id}'\n"
}
],
"tags": [
"Orders"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreOrdersRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}": {
"get": {
"operationId": "GetPaymentCollectionsPaymentCollection",
"summary": "Get a PaymentCollection",
"description": "Get a Payment Collection",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the PaymentCollection.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "Comma separated list of relations to include in the results.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "Comma separated list of fields to include in the results.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve",
"queryParams": "StoreGetPaymentCollectionsParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.paymentCollections.retrieve(paymentCollectionId)\n .then(({ payment_collection }) => {\n console.log(payment_collection.id)\n })\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/payment-collections/{id}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}/sessions": {
"post": {
"operationId": "PostPaymentCollectionsSessions",
"summary": "Manage a Payment Session",
"description": "Manages Payment Sessions from Payment Collections.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Payment Collection.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionSessionsReq"
}
}
}
},
"x-codegen": {
"method": "managePaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\n\n// Total amount = 10000\n\n// Adding a payment session\nmedusa.paymentCollections.managePaymentSession(payment_id, { provider_id: \"stripe\" })\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}/sessions/batch": {
"post": {
"operationId": "PostPaymentCollectionsPaymentCollectionSessionsBatch",
"summary": "Manage Payment Sessions",
"description": "Manages Multiple Payment Sessions from Payment Collections.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Payment Collections.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostPaymentCollectionsBatchSessionsReq"
}
}
}
},
"x-codegen": {
"method": "managePaymentSessionsBatch"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\n\n// Total amount = 10000\n\n// Adding two new sessions\nmedusa.paymentCollections.managePaymentSessionsBatch(payment_id, [\n {\n provider_id: \"stripe\",\n amount: 5000,\n },\n {\n provider_id: \"manual\",\n amount: 5000,\n },\n])\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n});\n\n// Updating one session and removing the other\nmedusa.paymentCollections.managePaymentSessionsBatch(payment_id, [\n {\n provider_id: \"stripe\",\n amount: 10000,\n session_id: \"ps_123456\"\n },\n])\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}/sessions/batch/authorize": {
"post": {
"operationId": "PostPaymentCollectionsSessionsBatchAuthorize",
"summary": "Authorize PaymentSessions",
"description": "Authorizes Payment Sessions of a Payment Collection.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Payment Collections.",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq"
}
}
}
},
"x-codegen": {
"method": "authorizePaymentSessionsBatch"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.paymentCollections.authorize(payment_id)\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/batch/authorize'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}/sessions/{session_id}": {
"post": {
"operationId": "PostPaymentCollectionsPaymentCollectionPaymentSessionsSession",
"summary": "Refresh a Payment Session",
"description": "Refreshes a Payment Session to ensure that it is in sync with the Payment Collection.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the PaymentCollection.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"description": "The id of the Payment Session to be refreshed.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "refreshPaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.paymentCollections.refreshPaymentSession(payment_collection_id, session_id)\n.then(({ payment_session }) => {\n console.log(payment_session.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}'\n"
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsSessionRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/payment-collections/{id}/sessions/{session_id}/authorize": {
"post": {
"operationId": "PostPaymentCollectionsSessionsSessionAuthorize",
"summary": "Authorize Payment Session",
"description": "Authorizes a Payment Session of a Payment Collection.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Payment Collections.",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"description": "The ID of the Payment Session.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "authorizePaymentSession"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.paymentCollections.authorize(payment_id, session_id)\n.then(({ payment_collection }) => {\n console.log(payment_collection.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/payment-collections/{id}/sessions/{session_id}/authorize'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Payment Collections"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePaymentCollectionsSessionRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/product-categories": {
"get": {
"operationId": "GetProductCategories",
"summary": "List Product Categories",
"description": "Retrieve a list of product categories.",
"x-authenticated": false,
"parameters": [
{
"in": "query",
"name": "q",
"description": "Query used for searching product category names or handles.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "handle",
"description": "Query used for searching product category by handle.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "parent_category_id",
"description": "Returns categories scoped by parent",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "include_descendants_tree",
"description": "Include all nested descendants of category",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "offset",
"description": "How many product categories to skip in the result.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of product categories returned.",
"schema": {
"type": "integer",
"default": 100
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetProductCategoriesParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.productCategories.list()\n.then(({ product_categories, limit, offset, count }) => {\n console.log(product_categories.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/product-categories' \\\n--header 'Authorization: Bearer {api_token}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Product Categories"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGetProductCategoriesRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/product-categories/{id}": {
"get": {
"operationId": "GetProductCategoriesCategory",
"summary": "Get a Product Category",
"description": "Retrieves a Product Category.",
"x-authenticated": false,
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The ID of the Product Category",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated) Which fields should be expanded in each product category.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated) Which fields should be retrieved in each product category.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve",
"queryParams": "StoreGetProductCategoriesCategoryParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.productCategories.retrieve(product_category_id)\n .then(({ product_category }) => {\n console.log(product_category.id);\n });\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/product-categories/{id}' \\\n--header 'Authorization: Bearer {api_token}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Product Categories"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreGetProductCategoriesCategoryRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/product-tags": {
"get": {
"operationId": "GetProductTags",
"summary": "List Product Tags",
"description": "Retrieve a list of Product Tags.",
"x-authenticated": true,
"x-codegen": {
"method": "list",
"queryParams": "StoreGetProductTagsParams"
},
"parameters": [
{
"in": "query",
"name": "limit",
"description": "The number of types to return.",
"schema": {
"type": "integer",
"default": 20
}
},
{
"in": "query",
"name": "offset",
"description": "The number of items to skip before the results.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "order",
"description": "The field to sort items by.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "discount_condition_id",
"description": "The discount condition id on which to filter the product tags.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "value",
"style": "form",
"explode": false,
"description": "The tag values to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "id",
"style": "form",
"explode": false,
"description": "The tag IDs to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "q",
"description": "A query string to search values for",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting product tags were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting product tags were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
}
],
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.productTags.list()\n.then(({ product_tags }) => {\n console.log(product_tags.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/product-tags'\n"
}
],
"tags": [
"Product Tags"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreProductTagsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/product-types": {
"get": {
"operationId": "GetProductTypes",
"summary": "List Product Types",
"description": "Retrieve a list of Product Types.",
"x-authenticated": true,
"parameters": [
{
"in": "query",
"name": "limit",
"description": "The number of types to return.",
"schema": {
"type": "integer",
"default": 20
}
},
{
"in": "query",
"name": "offset",
"description": "The number of items to skip before the results.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "order",
"description": "The field to sort items by.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "discount_condition_id",
"description": "The discount condition id on which to filter the product types.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "value",
"style": "form",
"explode": false,
"description": "The type values to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "id",
"style": "form",
"explode": false,
"description": "The type IDs to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "q",
"description": "A query string to search values for",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting product types were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting product types were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetProductTypesParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.productTypes.list()\n.then(({ product_types }) => {\n console.log(product_types.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/product-types' \\\n--header 'Authorization: Bearer {api_token}'\n"
}
],
"security": [
{
"api_token": []
},
{
"cookie_auth": []
}
],
"tags": [
"Product Types"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreProductTypesListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/products": {
"get": {
"operationId": "GetProducts",
"summary": "List Products",
"description": "Retrieves a list of Products.",
"parameters": [
{
"in": "query",
"name": "q",
"description": "Query used for searching products by title, description, variant's title, variant's sku, and collection's title",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "id",
"style": "form",
"explode": false,
"description": "product IDs to search for.",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
},
{
"in": "query",
"name": "sales_channel_id",
"style": "form",
"explode": false,
"description": "an array of sales channel IDs to filter the retrieved products by.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "collection_id",
"style": "form",
"explode": false,
"description": "Collection IDs to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "type_id",
"style": "form",
"explode": false,
"description": "Type IDs to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "tags",
"style": "form",
"explode": false,
"description": "Tag IDs to search for",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "title",
"description": "title to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "description",
"description": "description to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "handle",
"description": "handle to search for.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "is_giftcard",
"description": "Search for giftcards using is_giftcard=true.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting products were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting products were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "category_id",
"style": "form",
"explode": false,
"description": "Category ids to filter by.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "include_category_children",
"description": "Include category children when filtering by category_id.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "offset",
"description": "How many products to skip in the result.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of products returned.",
"schema": {
"type": "integer",
"default": 100
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated) Which fields should be expanded in each product of the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated) Which fields should be included in each product of the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "order",
"description": "the field used to order the products.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cart_id",
"description": "The id of the Cart to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "The id of the Region to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "currency_code",
"description": "The currency code to use for price selection.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetProductsParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.products.list()\n.then(({ products, limit, offset, count }) => {\n console.log(products.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/products'\n"
}
],
"tags": [
"Products"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreProductsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/products/search": {
"post": {
"operationId": "PostProductsSearch",
"summary": "Search Products",
"description": "Run a search query on products using the search engine installed on Medusa",
"parameters": [
{
"in": "query",
"name": "q",
"required": true,
"description": "The query to run the search with.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "offset",
"description": "How many products to skip in the result.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of products returned.",
"schema": {
"type": "integer"
}
}
],
"x-codegen": {
"method": "search",
"queryParams": "StorePostSearchReq"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.products.search({\n q: 'Shirt'\n})\n.then(({ hits }) => {\n console.log(hits.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/products/search?q=Shirt'\n"
}
],
"tags": [
"Products"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostSearchRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/products/{id}": {
"get": {
"operationId": "GetProductsProduct",
"summary": "Get a Product",
"description": "Retrieves a Product.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Product.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sales_channel_id",
"description": "The sales channel used when fetching the product.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cart_id",
"description": "The ID of the customer's cart.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "The ID of the region the customer is using. This is helpful to ensure correct prices are retrieved for a region.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "(Comma separated) Which fields should be included in the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "(Comma separated) Which fields should be expanded in each product of the result.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "currency_code",
"style": "form",
"explode": false,
"description": "The 3 character ISO currency code to set prices based on. This is helpful to ensure correct prices are retrieved for a currency.",
"schema": {
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
}
}
],
"x-codegen": {
"method": "retrieve",
"queryParams": "StoreGetProductsProductParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.products.retrieve(product_id)\n.then(({ product }) => {\n console.log(product.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/products/{id}'\n"
}
],
"tags": [
"Products"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreProductsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/regions": {
"get": {
"operationId": "GetRegions",
"summary": "List Regions",
"description": "Retrieves a list of Regions.",
"parameters": [
{
"in": "query",
"name": "offset",
"description": "How many regions to skip in the result.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of regions returned.",
"schema": {
"type": "integer",
"default": 100
}
},
{
"in": "query",
"name": "created_at",
"description": "Date comparison for when resulting regions were created.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
},
{
"in": "query",
"name": "updated_at",
"description": "Date comparison for when resulting regions were updated.",
"schema": {
"type": "object",
"properties": {
"lt": {
"type": "string",
"description": "filter by dates less than this date",
"format": "date"
},
"gt": {
"type": "string",
"description": "filter by dates greater than this date",
"format": "date"
},
"lte": {
"type": "string",
"description": "filter by dates less than or equal to this date",
"format": "date"
},
"gte": {
"type": "string",
"description": "filter by dates greater than or equal to this date",
"format": "date"
}
}
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetRegionsParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.regions.list()\n.then(({ regions }) => {\n console.log(regions.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/regions'\n"
}
],
"tags": [
"Regions"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreRegionsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/regions/{id}": {
"get": {
"operationId": "GetRegionsRegion",
"summary": "Get a Region",
"description": "Retrieves a Region.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Region.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.regions.retrieve(region_id)\n.then(({ region }) => {\n console.log(region.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/regions/{id}'\n"
}
],
"tags": [
"Regions"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreRegionsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/return-reasons": {
"get": {
"operationId": "GetReturnReasons",
"summary": "List Return Reasons",
"description": "Retrieves a list of Return Reasons.",
"x-codegen": {
"method": "list"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.returnReasons.list()\n.then(({ return_reasons }) => {\n console.log(return_reasons.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/return-reasons'\n"
}
],
"tags": [
"Return Reasons"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreReturnReasonsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/return-reasons/{id}": {
"get": {
"operationId": "GetReturnReasonsReason",
"summary": "Get a Return Reason",
"description": "Retrieves a Return Reason.",
"parameters": [
{
"in": "path",
"name": "id",
"required": true,
"description": "The id of the Return Reason.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieve"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.returnReasons.retrieve(reason_id)\n.then(({ return_reason }) => {\n console.log(return_reason.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/return-reasons/{id}'\n"
}
],
"tags": [
"Return Reasons"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreReturnReasonsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/returns": {
"post": {
"operationId": "PostReturns",
"summary": "Create Return",
"description": "Creates a Return for an Order.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostReturnsReq"
}
}
}
},
"x-codegen": {
"method": "create"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.returns.create({\n order_id,\n items: [\n {\n item_id,\n quantity: 1\n }\n ]\n})\n.then((data) => {\n console.log(data.return.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/returns' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"order_id\": \"asfasf\",\n \"items\": [\n {\n \"item_id\": \"assfasf\",\n \"quantity\": 1\n }\n ]\n}'\n"
}
],
"tags": [
"Returns"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreReturnsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/shipping-options": {
"get": {
"operationId": "GetShippingOptions",
"summary": "Get Shipping Options",
"description": "Retrieves a list of Shipping Options.",
"parameters": [
{
"in": "query",
"name": "is_return",
"description": "Whether return Shipping Options should be included. By default all Shipping Options are returned.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "product_ids",
"description": "A comma separated list of Product ids to filter Shipping Options by.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "the Region to retrieve Shipping Options from.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetShippingOptionsParams"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.shippingOptions.list()\n.then(({ shipping_options }) => {\n console.log(shipping_options.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/shipping-options'\n"
}
],
"tags": [
"Shipping Options"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreShippingOptionsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/shipping-options/{cart_id}": {
"get": {
"operationId": "GetShippingOptionsCartId",
"summary": "List for Cart",
"description": "Retrieves a list of Shipping Options available to a cart.",
"parameters": [
{
"in": "path",
"name": "cart_id",
"required": true,
"description": "The id of the Cart.",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "listCartOptions"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.shippingOptions.listCartOptions(cart_id)\n.then(({ shipping_options }) => {\n console.log(shipping_options.length);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/shipping-options/{cart_id}'\n"
}
],
"tags": [
"Shipping Options"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreCartShippingOptionsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/swaps": {
"post": {
"operationId": "PostSwaps",
"summary": "Create a Swap",
"description": "Creates a Swap on an Order by providing some items to return along with some items to send back",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StorePostSwapsReq"
}
}
}
},
"x-codegen": {
"method": "create"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.swaps.create({\n order_id,\n return_items: [\n {\n item_id,\n quantity: 1\n }\n ],\n additional_items: [\n {\n variant_id,\n quantity: 1\n }\n ]\n})\n.then(({ swap }) => {\n console.log(swap.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request POST 'https://medusa-url.com/store/swaps' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"order_id\": \"asfasf\",\n \"return_items\": [\n {\n \"item_id\": \"asfas\",\n \"quantity\": 1\n }\n ],\n \"additional_items\": [\n {\n \"variant_id\": \"asfas\",\n \"quantity\": 1\n }\n ]\n}'\n"
}
],
"tags": [
"Swaps"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreSwapsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/swaps/{cart_id}": {
"get": {
"operationId": "GetSwapsSwapCartId",
"summary": "Get by Cart ID",
"description": "Retrieves a Swap by the id of the Cart used to confirm the Swap.",
"parameters": [
{
"in": "path",
"name": "cart_id",
"required": true,
"description": "The id of the Cart",
"schema": {
"type": "string"
}
}
],
"x-codegen": {
"method": "retrieveByCartId"
},
"x-codeSamples": [
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\nmedusa.swaps.retrieveByCartId(cart_id)\n.then(({ swap }) => {\n console.log(swap.id);\n});\n"
},
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/swaps/{cart_id}'\n"
}
],
"tags": [
"Swaps"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreSwapsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/variants": {
"get": {
"operationId": "GetVariants",
"summary": "Get Product Variants",
"description": "Retrieves a list of Product Variants",
"parameters": [
{
"in": "query",
"name": "ids",
"description": "A comma separated list of Product Variant ids to filter by.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sales_channel_id",
"description": "A sales channel id for result configuration.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "expand",
"description": "A comma separated list of Product Variant relations to load.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "offset",
"description": "How many product variants to skip in the result.",
"schema": {
"type": "number",
"default": "0"
}
},
{
"in": "query",
"name": "limit",
"description": "Maximum number of Product Variants to return.",
"schema": {
"type": "number",
"default": "100"
}
},
{
"in": "query",
"name": "cart_id",
"description": "The id of the Cart to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "The id of the Region to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "currency_code",
"description": "The currency code to use for price selection.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "title",
"style": "form",
"explode": false,
"description": "product variant title to search for.",
"schema": {
"oneOf": [
{
"type": "string",
"description": "a single title to search by"
},
{
"type": "array",
"description": "multiple titles to search by",
"items": {
"type": "string"
}
}
]
}
},
{
"in": "query",
"name": "inventory_quantity",
"description": "Filter by available inventory quantity",
"schema": {
"oneOf": [
{
"type": "number",
"description": "a specific number to search by."
},
{
"type": "object",
"description": "search using less and greater than comparisons.",
"properties": {
"lt": {
"type": "number",
"description": "filter by inventory quantity less than this number"
},
"gt": {
"type": "number",
"description": "filter by inventory quantity greater than this number"
},
"lte": {
"type": "number",
"description": "filter by inventory quantity less than or equal to this number"
},
"gte": {
"type": "number",
"description": "filter by inventory quantity greater than or equal to this number"
}
}
}
]
}
}
],
"x-codegen": {
"method": "list",
"queryParams": "StoreGetVariantsParams"
},
"x-codeSamples": [
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/variants'\n"
}
],
"tags": [
"Variants"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreVariantsListRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
},
"/store/variants/{variant_id}": {
"get": {
"operationId": "GetVariantsVariant",
"summary": "Get a Product Variant",
"description": "Retrieves a Product Variant by id",
"parameters": [
{
"in": "path",
"name": "variant_id",
"required": true,
"description": "The id of the Product Variant.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "cart_id",
"description": "The id of the Cart to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "sales_channel_id",
"description": "A sales channel id for result configuration.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "region_id",
"description": "The id of the Region to set prices based on.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "currency_code",
"style": "form",
"explode": false,
"description": "The 3 character ISO currency code to set prices based on.",
"schema": {
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
}
}
],
"x-codegen": {
"method": "retrieve",
"queryParams": "StoreGetVariantsVariantParams"
},
"x-codeSamples": [
{
"lang": "Shell",
"label": "cURL",
"source": "curl --location --request GET 'https://medusa-url.com/store/variants/{id}'\n"
}
],
"tags": [
"Variants"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoreVariantsRes"
}
}
}
},
"400": {
"$ref": "#/components/responses/400_error"
},
"404": {
"$ref": "#/components/responses/not_found_error"
},
"409": {
"$ref": "#/components/responses/invalid_state_error"
},
"422": {
"$ref": "#/components/responses/invalid_request_error"
},
"500": {
"$ref": "#/components/responses/500_error"
}
}
}
}
},
"components": {
"responses": {
"default_error": {
"description": "Default Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"code": "unknown_error",
"message": "An unknown error occurred.",
"type": "unknown_error"
}
}
}
},
"invalid_state_error": {
"description": "Invalid State Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}
}
}
},
"invalid_request_error": {
"description": "Invalid Request Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}
}
}
},
"not_found_error": {
"description": "Not Found Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"message": "Entity with id 1 was not found",
"type": "not_found"
}
}
}
},
"400_error": {
"description": "Client Error or Multiple Errors",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"$ref": "#/components/schemas/MultipleErrors"
}
]
},
"examples": {
"not_allowed": {
"$ref": "#/components/examples/not_allowed_error"
},
"invalid_data": {
"$ref": "#/components/examples/invalid_data_error"
},
"MultipleErrors": {
"$ref": "#/components/examples/multiple_errors"
}
}
}
}
},
"500_error": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"database": {
"$ref": "#/components/examples/database_error"
},
"unexpected_state": {
"$ref": "#/components/examples/unexpected_state_error"
},
"invalid_argument": {
"$ref": "#/components/examples/invalid_argument_error"
},
"default_error": {
"$ref": "#/components/examples/default_error"
}
}
}
}
},
"unauthorized": {
"description": "User is not authorized. Must log in first",
"content": {
"text/plain": {
"schema": {
"type": "string",
"default": "Unauthorized",
"example": "Unauthorized"
}
}
}
},
"incorrect_credentials": {
"description": "User does not exist or incorrect credentials",
"content": {
"text/plain": {
"schema": {
"type": "string",
"default": "Unauthorized",
"example": "Unauthorized"
}
}
}
}
},
"examples": {
"not_allowed_error": {
"summary": "Not Allowed Error",
"value": {
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}
},
"invalid_data_error": {
"summary": "Invalid Data Error",
"value": {
"message": "first_name must be a string",
"type": "invalid_data"
}
},
"multiple_errors": {
"summary": "Multiple Errors",
"value": {
"message": "Provided request body contains errors. Please check the data and retry the request",
"errors": [
{
"message": "first_name must be a string",
"type": "invalid_data"
},
{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}
]
}
},
"database_error": {
"summary": "Database Error",
"value": {
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}
},
"unexpected_state_error": {
"summary": "Unexpected State Error",
"value": {
"message": "cart.total must be defined",
"type": "unexpected_state"
}
},
"invalid_argument_error": {
"summary": "Invalid Argument Error",
"value": {
"message": "cart.total must be defined",
"type": "unexpected_state"
}
},
"default_error": {
"summary": "Default Error",
"value": {
"code": "unknown_error",
"message": "An unknown error occurred.",
"type": "unknown_error"
}
}
},
"securitySchemes": {
"cookie_auth": {
"type": "apiKey",
"x-displayName": "Cookie Session ID",
"in": "cookie",
"name": "connect.sid",
"description": "Use a cookie session to send authenticated requests.\n\n### How to Obtain the Cookie Session\n\nIf you're sending requests through a browser, using JS Client, or using tools like Postman, the cookie session should be automatically set when the customer is logged in.\n\nIf you're sending requests using cURL, you must set the Session ID in the cookie manually.\n\nTo do that, send a request to [authenticate the customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`:\n\n```bash\ncurl -v --location --request POST 'https://medusa-url.com/store/auth' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"email\": \"user@example.com\",\n \"password\": \"supersecret\"\n}'\n```\n\nThe headers will be logged in the terminal as well as the response. You should find in the headers a Cookie header similar to this:\n\n```bash\nSet-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM;\n```\n\nCopy the value after `connect.sid` (without the `;` at the end) and pass it as a cookie in subsequent requests as the following:\n\n```bash\ncurl --location --request GET 'https://medusa-url.com/store/customers/me/orders' \\\n--header 'Cookie: connect.sid={sid}'\n```\n\nWhere `{sid}` is the value of `connect.sid` that you copied.\n"
}
},
"schemas": {
"Address": {
"title": "Address",
"description": "An address.",
"type": "object",
"required": [
"address_1",
"address_2",
"city",
"company",
"country_code",
"created_at",
"customer_id",
"deleted_at",
"first_name",
"id",
"last_name",
"metadata",
"phone",
"postal_code",
"province",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"description": "ID of the address",
"example": "addr_01G8ZC9VS1XVE149MGH2J7QSSH"
},
"customer_id": {
"description": "ID of the customer this address belongs to",
"nullable": true,
"type": "string",
"example": "cus_01G2SG30J8C85S4A5CHM2S1NS2"
},
"customer": {
"description": "Available if the relation `customer` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Customer"
},
"company": {
"description": "Company name",
"nullable": true,
"type": "string",
"example": "Acme"
},
"first_name": {
"description": "First name",
"nullable": true,
"type": "string",
"example": "Arno"
},
"last_name": {
"description": "Last name",
"nullable": true,
"type": "string",
"example": "Willms"
},
"address_1": {
"description": "Address line 1",
"nullable": true,
"type": "string",
"example": "14433 Kemmer Court"
},
"address_2": {
"description": "Address line 2",
"nullable": true,
"type": "string",
"example": "Suite 369"
},
"city": {
"description": "City",
"nullable": true,
"type": "string",
"example": "South Geoffreyview"
},
"country_code": {
"description": "The 2 character ISO code of the country in lower case",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
},
"example": "st"
},
"country": {
"description": "A country object. Available if the relation `country` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Country"
},
"province": {
"description": "Province",
"nullable": true,
"type": "string",
"example": "Kentucky"
},
"postal_code": {
"description": "Postal Code",
"nullable": true,
"type": "string",
"example": 72093
},
"phone": {
"description": "Phone Number",
"nullable": true,
"type": "string",
"example": 16128234334802
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"AddressCreatePayload": {
"type": "object",
"description": "Address fields used when creating an address.",
"required": [
"first_name",
"last_name",
"address_1",
"city",
"country_code",
"postal_code"
],
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"example": "Arno"
},
"last_name": {
"description": "Last name",
"type": "string",
"example": "Willms"
},
"phone": {
"type": "string",
"description": "Phone Number",
"example": 16128234334802
},
"company": {
"type": "string"
},
"address_1": {
"description": "Address line 1",
"type": "string",
"example": "14433 Kemmer Court"
},
"address_2": {
"description": "Address line 2",
"type": "string",
"example": "Suite 369"
},
"city": {
"description": "City",
"type": "string",
"example": "South Geoffreyview"
},
"country_code": {
"description": "The 2 character ISO code of the country in lower case",
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
},
"example": "st"
},
"province": {
"description": "Province",
"type": "string",
"example": "Kentucky"
},
"postal_code": {
"description": "Postal Code",
"type": "string",
"example": 72093
},
"metadata": {
"type": "object",
"example": {
"car": "white"
},
"description": "An optional key-value map with additional details"
}
}
},
"AddressPayload": {
"type": "object",
"description": "Address fields used when creating/updating an address.",
"properties": {
"first_name": {
"description": "First name",
"type": "string",
"example": "Arno"
},
"last_name": {
"description": "Last name",
"type": "string",
"example": "Willms"
},
"phone": {
"type": "string",
"description": "Phone Number",
"example": 16128234334802
},
"company": {
"type": "string"
},
"address_1": {
"description": "Address line 1",
"type": "string",
"example": "14433 Kemmer Court"
},
"address_2": {
"description": "Address line 2",
"type": "string",
"example": "Suite 369"
},
"city": {
"description": "City",
"type": "string",
"example": "South Geoffreyview"
},
"country_code": {
"description": "The 2 character ISO code of the country in lower case",
"type": "string",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
},
"example": "st"
},
"province": {
"description": "Province",
"type": "string",
"example": "Kentucky"
},
"postal_code": {
"description": "Postal Code",
"type": "string",
"example": 72093
},
"metadata": {
"type": "object",
"example": {
"car": "white"
},
"description": "An optional key-value map with additional details"
}
}
},
"BatchJob": {
"title": "Batch Job",
"description": "A Batch Job.",
"type": "object",
"required": [
"canceled_at",
"completed_at",
"confirmed_at",
"context",
"created_at",
"created_by",
"deleted_at",
"dry_run",
"failed_at",
"id",
"pre_processed_at",
"processing_at",
"result",
"status",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The unique identifier for the batch job.",
"type": "string",
"example": "batch_01G8T782965PYFG0751G0Z38B4"
},
"type": {
"description": "The type of batch job.",
"type": "string",
"enum": [
"product-import",
"product-export"
]
},
"status": {
"description": "The status of the batch job.",
"type": "string",
"enum": [
"created",
"pre_processed",
"confirmed",
"processing",
"completed",
"canceled",
"failed"
],
"default": "created"
},
"created_by": {
"description": "The unique identifier of the user that created the batch job.",
"nullable": true,
"type": "string",
"example": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V"
},
"created_by_user": {
"description": "A user object. Available if the relation `created_by_user` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/User"
},
"context": {
"description": "The context of the batch job, the type of the batch job determines what the context should contain.",
"nullable": true,
"type": "object",
"example": {
"shape": {
"prices": [
{
"region": null,
"currency_code": "eur"
}
],
"dynamicImageColumnCount": 4,
"dynamicOptionColumnCount": 2
},
"list_config": {
"skip": 0,
"take": 50,
"order": {
"created_at": "DESC"
},
"relations": [
"variants",
"variant.prices",
"images"
]
}
}
},
"dry_run": {
"description": "Specify if the job must apply the modifications or not.",
"type": "boolean",
"default": false
},
"result": {
"description": "The result of the batch job.",
"nullable": true,
"allOf": [
{
"type": "object",
"example": {}
},
{
"type": "object",
"properties": {
"count": {
"type": "number"
},
"advancement_count": {
"type": "number"
},
"progress": {
"type": "number"
},
"errors": {
"type": "object",
"properties": {
"message": {
"type": "string"
},
"code": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"err": {
"type": "array"
}
}
},
"stat_descriptors": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"name": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"file_key": {
"type": "string"
},
"file_size": {
"type": "number"
}
}
}
],
"example": {
"errors": [
{
"err": [],
"code": "unknown",
"message": "Method not implemented."
}
],
"stat_descriptors": [
{
"key": "product-export-count",
"name": "Product count to export",
"message": "There will be 8 products exported by this action"
}
]
}
},
"pre_processed_at": {
"description": "The date from which the job has been pre-processed.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"processing_at": {
"description": "The date the job is processing at.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"confirmed_at": {
"description": "The date when the confirmation has been done.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"completed_at": {
"description": "The date of the completion.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"canceled_at": {
"description": "The date of the concellation.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"failed_at": {
"description": "The date when the job failed.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was last updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"Cart": {
"title": "Cart",
"description": "Represents a user cart",
"type": "object",
"required": [
"billing_address_id",
"completed_at",
"context",
"created_at",
"customer_id",
"deleted_at",
"email",
"id",
"idempotency_key",
"metadata",
"payment_authorized_at",
"payment_id",
"payment_session",
"region_id",
"shipping_address_id",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The cart's ID",
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"email": {
"description": "The email associated with the cart",
"nullable": true,
"type": "string",
"format": "email"
},
"billing_address_id": {
"description": "The billing address's ID",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"billing_address": {
"description": "Available if the relation `billing_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"shipping_address_id": {
"description": "The shipping address's ID",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"shipping_address": {
"description": "Available if the relation `shipping_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"items": {
"description": "Available if the relation `items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"region_id": {
"description": "The region's ID",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"discounts": {
"description": "Available if the relation `discounts` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Discount"
}
},
"gift_cards": {
"description": "Available if the relation `gift_cards` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/GiftCard"
}
},
"customer_id": {
"description": "The customer's ID",
"nullable": true,
"type": "string",
"example": "cus_01G2SG30J8C85S4A5CHM2S1NS2"
},
"customer": {
"description": "A customer object. Available if the relation `customer` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Customer"
},
"payment_session": {
"description": "The selected payment session in the cart.",
"nullable": true,
"$ref": "#/components/schemas/PaymentSession"
},
"payment_sessions": {
"description": "The payment sessions created on the cart.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSession"
}
},
"payment_id": {
"description": "The payment's ID if available",
"nullable": true,
"type": "string",
"example": "pay_01G8ZCC5W42ZNY842124G7P5R9"
},
"payment": {
"description": "Available if the relation `payment` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Payment"
},
"shipping_methods": {
"description": "The shipping methods added to the cart.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMethod"
}
},
"type": {
"description": "The cart's type.",
"type": "string",
"enum": [
"default",
"swap",
"draft_order",
"payment_link",
"claim"
],
"default": "default"
},
"completed_at": {
"description": "The date with timezone at which the cart was completed.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"payment_authorized_at": {
"description": "The date with timezone at which the payment was authorized.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of a cart in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"context": {
"description": "The context of the cart which can include info like IP or user agent.",
"nullable": true,
"type": "object",
"example": {
"ip": "::1",
"user_agent": "PostmanRuntime/7.29.2"
}
},
"sales_channel_id": {
"description": "The sales channel ID the cart is associated with.",
"nullable": true,
"type": "string",
"example": null
},
"sales_channel": {
"description": "A sales channel object. Available if the relation `sales_channel` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/SalesChannel"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
},
"shipping_total": {
"description": "The total of shipping",
"type": "integer",
"example": 1000
},
"discount_total": {
"description": "The total of discount rounded",
"type": "integer",
"example": 800
},
"raw_discount_total": {
"description": "The total of discount",
"type": "integer",
"example": 800
},
"item_tax_total": {
"description": "The total of items with taxes",
"type": "integer",
"example": 8000
},
"shipping_tax_total": {
"description": "The total of shipping with taxes",
"type": "integer",
"example": 1000
},
"tax_total": {
"description": "The total of tax",
"type": "integer",
"example": 0
},
"refunded_total": {
"description": "The total amount refunded if the order associated with this cart is returned.",
"type": "integer",
"example": 0
},
"total": {
"description": "The total amount of the cart",
"type": "integer",
"example": 8200
},
"subtotal": {
"description": "The subtotal of the cart",
"type": "integer",
"example": 8000
},
"refundable_amount": {
"description": "The amount that can be refunded",
"type": "integer",
"example": 8200
},
"gift_card_total": {
"description": "The total of gift cards",
"type": "integer",
"example": 0
},
"gift_card_tax_total": {
"description": "The total of gift cards with taxes",
"type": "integer",
"example": 0
}
}
},
"ClaimImage": {
"title": "Claim Image",
"description": "Represents photo documentation of a claim.",
"type": "object",
"required": [
"claim_item_id",
"created_at",
"deleted_at",
"id",
"metadata",
"updated_at",
"url"
],
"properties": {
"id": {
"description": "The claim image's ID",
"type": "string",
"example": "cimg_01G8ZH853Y6TFXWPG5EYE81X63"
},
"claim_item_id": {
"description": "The ID of the claim item associated with the image",
"type": "string"
},
"claim_item": {
"description": "A claim item object. Available if the relation `claim_item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimItem"
},
"url": {
"description": "The URL of the image",
"type": "string",
"format": "uri"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ClaimItem": {
"title": "Claim Item",
"description": "Represents a claimed item along with information about the reasons for the claim.",
"type": "object",
"required": [
"claim_order_id",
"created_at",
"deleted_at",
"id",
"item_id",
"metadata",
"note",
"quantity",
"reason",
"updated_at",
"variant_id"
],
"properties": {
"id": {
"description": "The claim item's ID",
"type": "string",
"example": "citm_01G8ZH853Y6TFXWPG5EYE81X63"
},
"images": {
"description": "Available if the relation `images` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ClaimImage"
}
},
"claim_order_id": {
"description": "The ID of the claim this item is associated with.",
"type": "string"
},
"claim_order": {
"description": "A claim order object. Available if the relation `claim_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimOrder"
},
"item_id": {
"description": "The ID of the line item that the claim item refers to.",
"type": "string",
"example": "item_01G8ZM25TN49YV9EQBE2NC27KC"
},
"item": {
"description": "Available if the relation `item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"variant_id": {
"description": "The ID of the product variant that is claimed.",
"type": "string",
"example": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6"
},
"variant": {
"description": "A variant object. Available if the relation `variant` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductVariant"
},
"reason": {
"description": "The reason for the claim",
"type": "string",
"enum": [
"missing_item",
"wrong_item",
"production_failure",
"other"
]
},
"note": {
"description": "An optional note about the claim, for additional information",
"nullable": true,
"type": "string",
"example": "I don't like it."
},
"quantity": {
"description": "The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.",
"type": "integer",
"example": 1
},
"tags": {
"description": "User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ClaimTag"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ClaimOrder": {
"title": "Claim Order",
"description": "Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns.",
"type": "object",
"required": [
"canceled_at",
"created_at",
"deleted_at",
"fulfillment_status",
"id",
"idempotency_key",
"metadata",
"no_notification",
"order_id",
"payment_status",
"refund_amount",
"shipping_address_id",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The claim's ID",
"type": "string",
"example": "claim_01G8ZH853Y6TFXWPG5EYE81X63"
},
"type": {
"description": "The claim's type",
"type": "string",
"enum": [
"refund",
"replace"
]
},
"payment_status": {
"description": "The status of the claim's payment",
"type": "string",
"enum": [
"na",
"not_refunded",
"refunded"
],
"default": "na"
},
"fulfillment_status": {
"description": "The claim's fulfillment status",
"type": "string",
"enum": [
"not_fulfilled",
"partially_fulfilled",
"fulfilled",
"partially_shipped",
"shipped",
"partially_returned",
"returned",
"canceled",
"requires_action"
],
"default": "not_fulfilled"
},
"claim_items": {
"description": "The items that have been claimed",
"type": "array",
"items": {
"$ref": "#/components/schemas/ClaimItem"
}
},
"additional_items": {
"description": "Refers to the new items to be shipped when the claim order has the type `replace`",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"order_id": {
"description": "The ID of the order that the claim comes from.",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"return_order": {
"description": "A return object. Holds information about the return if the claim is to be returned. Available if the relation 'return_order' is expanded",
"nullable": true,
"$ref": "#/components/schemas/Return"
},
"shipping_address_id": {
"description": "The ID of the address that the new items should be shipped to",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"shipping_address": {
"description": "Available if the relation `shipping_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"shipping_methods": {
"description": "The shipping methods that the claim order will be shipped with.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMethod"
}
},
"fulfillments": {
"description": "The fulfillments of the new items to be shipped",
"type": "array",
"items": {
"$ref": "#/components/schemas/Fulfillment"
}
},
"refund_amount": {
"description": "The amount that will be refunded in conjunction with the claim",
"nullable": true,
"type": "integer",
"example": 1000
},
"canceled_at": {
"description": "The date with timezone at which the claim was canceled.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
},
"no_notification": {
"description": "Flag for describing whether or not notifications related to this should be send.",
"nullable": true,
"type": "boolean",
"example": false
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
}
}
},
"ClaimTag": {
"title": "Claim Tag",
"description": "Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The claim tag's ID",
"type": "string",
"example": "ctag_01G8ZCC5Y63B95V6B5SHBZ91S4"
},
"value": {
"description": "The value that the claim tag holds",
"type": "string",
"example": "Damaged"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Country": {
"title": "Country",
"description": "Country details",
"type": "object",
"required": [
"display_name",
"id",
"iso_2",
"iso_3",
"name",
"num_code",
"region_id"
],
"properties": {
"id": {
"description": "The country's ID",
"type": "string",
"example": 109
},
"iso_2": {
"description": "The 2 character ISO code of the country in lower case",
"type": "string",
"example": "it",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
}
},
"iso_3": {
"description": "The 2 character ISO code of the country in lower case",
"type": "string",
"example": "ita",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements",
"description": "See a list of codes."
}
},
"num_code": {
"description": "The numerical ISO code for the country.",
"type": "string",
"example": 380,
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements",
"description": "See a list of codes."
}
},
"name": {
"description": "The normalized country name in upper case.",
"type": "string",
"example": "ITALY"
},
"display_name": {
"description": "The country name appropriate for display.",
"type": "string",
"example": "Italy"
},
"region_id": {
"description": "The region ID this country is associated with.",
"nullable": true,
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
}
}
},
"CreateStockLocationInput": {
"title": "Create Stock Location Input",
"description": "Represents the Input to create a Stock Location",
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The stock location name"
},
"address_id": {
"type": "string",
"description": "The Stock location address ID"
},
"address": {
"description": "Stock location address object",
"allOf": [
{
"$ref": "#/components/schemas/StockLocationAddressInput"
},
{
"type": "object"
}
]
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
}
}
},
"Currency": {
"title": "Currency",
"description": "Currency",
"type": "object",
"required": [
"code",
"name",
"symbol",
"symbol_native"
],
"properties": {
"code": {
"description": "The 3 character ISO code for the currency.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"symbol": {
"description": "The symbol used to indicate the currency.",
"type": "string",
"example": "$"
},
"symbol_native": {
"description": "The native symbol used to indicate the currency.",
"type": "string",
"example": "$"
},
"name": {
"description": "The written name of the currency",
"type": "string",
"example": "US Dollar"
},
"includes_tax": {
"description": "[EXPERIMENTAL] Does the currency prices include tax",
"type": "boolean",
"default": false
}
}
},
"CustomShippingOption": {
"title": "Custom Shipping Option",
"description": "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option",
"type": "object",
"required": [
"cart_id",
"created_at",
"deleted_at",
"id",
"metadata",
"price",
"shipping_option_id",
"updated_at"
],
"properties": {
"id": {
"description": "The custom shipping option's ID",
"type": "string",
"example": "cso_01G8X99XNB77DMFBJFWX6DN9V9"
},
"price": {
"description": "The custom price set that will override the shipping option's original price",
"type": "integer",
"example": 1000
},
"shipping_option_id": {
"description": "The ID of the Shipping Option that the custom shipping option overrides",
"type": "string",
"example": "so_01G1G5V27GYX4QXNARRQCW1N8T"
},
"shipping_option": {
"description": "A shipping option object. Available if the relation `shipping_option` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingOption"
},
"cart_id": {
"description": "The ID of the Cart that the custom shipping option is attached to",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Customer": {
"title": "Customer",
"description": "Represents a customer",
"type": "object",
"required": [
"billing_address_id",
"created_at",
"deleted_at",
"email",
"first_name",
"has_account",
"id",
"last_name",
"metadata",
"phone",
"updated_at"
],
"properties": {
"id": {
"description": "The customer's ID",
"type": "string",
"example": "cus_01G2SG30J8C85S4A5CHM2S1NS2"
},
"email": {
"description": "The customer's email",
"type": "string",
"format": "email"
},
"first_name": {
"description": "The customer's first name",
"nullable": true,
"type": "string",
"example": "Arno"
},
"last_name": {
"description": "The customer's last name",
"nullable": true,
"type": "string",
"example": "Willms"
},
"billing_address_id": {
"description": "The customer's billing address ID",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"billing_address": {
"description": "Available if the relation `billing_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"shipping_addresses": {
"description": "Available if the relation `shipping_addresses` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Address"
}
},
"phone": {
"description": "The customer's phone number",
"nullable": true,
"type": "string",
"example": 16128234334802
},
"has_account": {
"description": "Whether the customer has an account or not",
"type": "boolean",
"default": false
},
"orders": {
"description": "Available if the relation `orders` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
},
"groups": {
"description": "The customer groups the customer belongs to. Available if the relation `groups` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerGroup"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"CustomerGroup": {
"title": "Customer Group",
"description": "Represents a customer group",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"name",
"updated_at"
],
"properties": {
"id": {
"description": "The customer group's ID",
"type": "string",
"example": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63"
},
"name": {
"description": "The name of the customer group",
"type": "string",
"example": "VIP"
},
"customers": {
"description": "The customers that belong to the customer group. Available if the relation `customers` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Customer"
}
},
"price_lists": {
"description": "The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PriceList"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Discount": {
"title": "Discount",
"description": "Represents a discount that can be applied to a cart for promotional purposes.",
"type": "object",
"required": [
"code",
"created_at",
"deleted_at",
"ends_at",
"id",
"is_disabled",
"is_dynamic",
"metadata",
"parent_discount_id",
"rule_id",
"starts_at",
"updated_at",
"usage_count",
"usage_limit",
"valid_duration"
],
"properties": {
"id": {
"description": "The discount's ID",
"type": "string",
"example": "disc_01F0YESMW10MGHWJKZSDDMN0VN"
},
"code": {
"description": "A unique code for the discount - this will be used by the customer to apply the discount",
"type": "string",
"example": "10DISC"
},
"is_dynamic": {
"description": "A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts",
"type": "boolean",
"example": false
},
"rule_id": {
"description": "The Discount Rule that governs the behaviour of the Discount",
"nullable": true,
"type": "string",
"example": "dru_01F0YESMVK96HVX7N419E3CJ7C"
},
"rule": {
"description": "Available if the relation `rule` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountRule"
},
"is_disabled": {
"description": "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts",
"type": "boolean",
"example": false
},
"parent_discount_id": {
"description": "The Discount that the discount was created from. This will always be a dynamic discount",
"nullable": true,
"type": "string",
"example": "disc_01G8ZH853YPY9B94857DY91YGW"
},
"parent_discount": {
"description": "Available if the relation `parent_discount` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Discount"
},
"starts_at": {
"description": "The time at which the discount can be used.",
"type": "string",
"format": "date-time"
},
"ends_at": {
"description": "The time at which the discount can no longer be used.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"valid_duration": {
"description": "Duration the discount runs between",
"nullable": true,
"type": "string",
"example": "P3Y6M4DT12H30M5S"
},
"regions": {
"description": "The Regions in which the Discount can be used. Available if the relation `regions` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
},
"usage_limit": {
"description": "The maximum number of times that a discount can be used.",
"nullable": true,
"type": "integer",
"example": 100
},
"usage_count": {
"description": "The number of times a discount has been used.",
"type": "integer",
"example": 50,
"default": 0
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountCondition": {
"title": "Discount Condition",
"description": "Holds rule conditions for when a discount is applicable",
"type": "object",
"required": [
"created_at",
"deleted_at",
"discount_rule_id",
"id",
"metadata",
"operator",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The discount condition's ID",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"type": {
"description": "The type of the Condition",
"type": "string",
"enum": [
"products",
"product_types",
"product_collections",
"product_tags",
"customer_groups"
]
},
"operator": {
"description": "The operator of the Condition",
"type": "string",
"enum": [
"in",
"not_in"
]
},
"discount_rule_id": {
"description": "The ID of the discount rule associated with the condition",
"type": "string",
"example": "dru_01F0YESMVK96HVX7N419E3CJ7C"
},
"discount_rule": {
"description": "Available if the relation `discount_rule` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountRule"
},
"products": {
"description": "products associated with this condition if type = products. Available if the relation `products` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"product_types": {
"description": "Product types associated with this condition if type = product_types. Available if the relation `product_types` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductType"
}
},
"product_tags": {
"description": "Product tags associated with this condition if type = product_tags. Available if the relation `product_tags` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductTag"
}
},
"product_collections": {
"description": "Product collections associated with this condition if type = product_collections. Available if the relation `product_collections` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCollection"
}
},
"customer_groups": {
"description": "Customer groups associated with this condition if type = customer_groups. Available if the relation `customer_groups` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerGroup"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountConditionCustomerGroup": {
"title": "Product Tag Discount Condition",
"description": "Associates a discount condition with a customer group",
"type": "object",
"required": [
"condition_id",
"created_at",
"customer_group_id",
"metadata",
"updated_at"
],
"properties": {
"customer_group_id": {
"description": "The ID of the Product Tag",
"type": "string",
"example": "cgrp_01G8ZH853Y6TFXWPG5EYE81X63"
},
"condition_id": {
"description": "The ID of the Discount Condition",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"customer_group": {
"description": "Available if the relation `customer_group` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/CustomerGroup"
},
"discount_condition": {
"description": "Available if the relation `discount_condition` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountCondition"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountConditionProduct": {
"title": "Product Discount Condition",
"description": "Associates a discount condition with a product",
"type": "object",
"required": [
"condition_id",
"created_at",
"metadata",
"product_id",
"updated_at"
],
"properties": {
"product_id": {
"description": "The ID of the Product Tag",
"type": "string",
"example": "prod_01G1G5V2MBA328390B5AXJ610F"
},
"condition_id": {
"description": "The ID of the Discount Condition",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"product": {
"description": "Available if the relation `product` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Product"
},
"discount_condition": {
"description": "Available if the relation `discount_condition` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountCondition"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountConditionProductCollection": {
"title": "Product Collection Discount Condition",
"description": "Associates a discount condition with a product collection",
"type": "object",
"required": [
"condition_id",
"created_at",
"metadata",
"product_collection_id",
"updated_at"
],
"properties": {
"product_collection_id": {
"description": "The ID of the Product Collection",
"type": "string",
"example": "pcol_01F0YESBFAZ0DV6V831JXWH0BG"
},
"condition_id": {
"description": "The ID of the Discount Condition",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"product_collection": {
"description": "Available if the relation `product_collection` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductCollection"
},
"discount_condition": {
"description": "Available if the relation `discount_condition` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountCondition"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountConditionProductTag": {
"title": "Product Tag Discount Condition",
"description": "Associates a discount condition with a product tag",
"type": "object",
"required": [
"condition_id",
"created_at",
"metadata",
"product_tag_id",
"updated_at"
],
"properties": {
"product_tag_id": {
"description": "The ID of the Product Tag",
"type": "string",
"example": "ptag_01F0YESHPZYY3H4SJ3A5918SBN"
},
"condition_id": {
"description": "The ID of the Discount Condition",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"product_tag": {
"description": "Available if the relation `product_tag` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductTag"
},
"discount_condition": {
"description": "Available if the relation `discount_condition` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountCondition"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountConditionProductType": {
"title": "Product Type Discount Condition",
"description": "Associates a discount condition with a product type",
"type": "object",
"required": [
"condition_id",
"created_at",
"metadata",
"product_type_id",
"updated_at"
],
"properties": {
"product_type_id": {
"description": "The ID of the Product Tag",
"type": "string",
"example": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"condition_id": {
"description": "The ID of the Discount Condition",
"type": "string",
"example": "discon_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"product_type": {
"description": "Available if the relation `product_type` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductType"
},
"discount_condition": {
"description": "Available if the relation `discount_condition` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DiscountCondition"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DiscountRule": {
"title": "Discount Rule",
"description": "Holds the rules that governs how a Discount is calculated when applied to a Cart.",
"type": "object",
"required": [
"allocation",
"created_at",
"deleted_at",
"description",
"id",
"metadata",
"type",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The discount rule's ID",
"type": "string",
"example": "dru_01F0YESMVK96HVX7N419E3CJ7C"
},
"type": {
"description": "The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.",
"type": "string",
"enum": [
"fixed",
"percentage",
"free_shipping"
],
"example": "percentage"
},
"description": {
"description": "A short description of the discount",
"nullable": true,
"type": "string",
"example": "10 Percent"
},
"value": {
"description": "The value that the discount represents; this will depend on the type of the discount",
"type": "integer",
"example": 10
},
"allocation": {
"description": "The scope that the discount should apply to.",
"nullable": true,
"type": "string",
"enum": [
"total",
"item"
],
"example": "total"
},
"conditions": {
"description": "A set of conditions that can be used to limit when the discount can be used. Available if the relation `conditions` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/DiscountCondition"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"DraftOrder": {
"title": "DraftOrder",
"description": "Represents a draft order",
"type": "object",
"required": [
"canceled_at",
"cart_id",
"completed_at",
"created_at",
"display_id",
"id",
"idempotency_key",
"metadata",
"no_notification_order",
"order_id",
"status",
"updated_at"
],
"properties": {
"id": {
"description": "The draft order's ID",
"type": "string",
"example": "dorder_01G8TJFKBG38YYFQ035MSVG03C"
},
"status": {
"description": "The status of the draft order",
"type": "string",
"enum": [
"open",
"completed"
],
"default": "open"
},
"display_id": {
"description": "The draft order's display ID",
"type": "string",
"example": 2
},
"cart_id": {
"description": "The ID of the cart associated with the draft order.",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"order_id": {
"description": "The ID of the order associated with the draft order.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"canceled_at": {
"description": "The date the draft order was canceled at.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"completed_at": {
"description": "The date the draft order was completed at.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"no_notification_order": {
"description": "Whether to send the customer notifications regarding order updates.",
"nullable": true,
"type": "boolean",
"example": false
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Error": {
"title": "Response Error",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "A slug code to indicate the type of the error."
},
"message": {
"type": "string",
"description": "Description of the error that occurred."
},
"type": {
"type": "string",
"description": "A slug indicating the type of the error."
}
}
},
"ExtendedStoreDTO": {
"allOf": [
{
"$ref": "#/components/schemas/Store"
},
{
"type": "object",
"required": [
"payment_providers",
"fulfillment_providers",
"feature_flags",
"modules"
],
"properties": {
"payment_providers": {
"$ref": "#/components/schemas/PaymentProvider"
},
"fulfillment_providers": {
"$ref": "#/components/schemas/FulfillmentProvider"
},
"feature_flags": {
"$ref": "#/components/schemas/FeatureFlagsResponse"
},
"modules": {
"$ref": "#/components/schemas/ModulesResponse"
}
}
}
]
},
"FeatureFlagsResponse": {
"type": "array",
"items": {
"type": "object",
"required": [
"key",
"value"
],
"properties": {
"key": {
"description": "The key of the feature flag.",
"type": "string"
},
"value": {
"description": "The value of the feature flag.",
"type": "boolean"
}
}
}
},
"Fulfillment": {
"title": "Fulfillment",
"description": "Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments.",
"type": "object",
"required": [
"canceled_at",
"claim_order_id",
"created_at",
"data",
"id",
"idempotency_key",
"location_id",
"metadata",
"no_notification",
"order_id",
"provider_id",
"shipped_at",
"swap_id",
"tracking_numbers",
"updated_at"
],
"properties": {
"id": {
"description": "The fulfillment's ID",
"type": "string",
"example": "ful_01G8ZRTMQCA76TXNAT81KPJZRF"
},
"claim_order_id": {
"description": "The id of the Claim that the Fulfillment belongs to.",
"nullable": true,
"type": "string",
"example": null
},
"claim_order": {
"description": "A claim order object. Available if the relation `claim_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimOrder"
},
"swap_id": {
"description": "The id of the Swap that the Fulfillment belongs to.",
"nullable": true,
"type": "string",
"example": null
},
"swap": {
"description": "A swap object. Available if the relation `swap` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Swap"
},
"order_id": {
"description": "The id of the Order that the Fulfillment belongs to.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"provider_id": {
"description": "The id of the Fulfillment Provider responsible for handling the fulfillment",
"type": "string",
"example": "manual"
},
"provider": {
"description": "Available if the relation `provider` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/FulfillmentProvider"
},
"location_id": {
"description": "The id of the stock location the fulfillment will be shipped from",
"nullable": true,
"type": "string",
"example": "sloc_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"items": {
"description": "The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentItem"
}
},
"tracking_links": {
"description": "The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingLink"
}
},
"tracking_numbers": {
"description": "The tracking numbers that can be used to track the status of the fulfillment.",
"deprecated": true,
"type": "array",
"items": {
"type": "string"
}
},
"data": {
"description": "This contains all the data necessary for the Fulfillment provider to handle the fulfillment.",
"type": "object",
"example": {}
},
"shipped_at": {
"description": "The date with timezone at which the Fulfillment was shipped.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"no_notification": {
"description": "Flag for describing whether or not notifications related to this should be sent.",
"nullable": true,
"type": "boolean",
"example": false
},
"canceled_at": {
"description": "The date with timezone at which the Fulfillment was canceled.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the fulfillment in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"FulfillmentItem": {
"title": "Fulfillment Item",
"description": "Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item.",
"type": "object",
"required": [
"fulfillment_id",
"item_id",
"quantity"
],
"properties": {
"fulfillment_id": {
"description": "The id of the Fulfillment that the Fulfillment Item belongs to.",
"type": "string",
"example": "ful_01G8ZRTMQCA76TXNAT81KPJZRF"
},
"item_id": {
"description": "The id of the Line Item that the Fulfillment Item references.",
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"fulfillment": {
"description": "A fulfillment object. Available if the relation `fulfillment` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Fulfillment"
},
"item": {
"description": "Available if the relation `item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"quantity": {
"description": "The quantity of the Line Item that is included in the Fulfillment.",
"type": "integer",
"example": 1
}
}
},
"FulfillmentProvider": {
"title": "Fulfillment Provider",
"description": "Represents a fulfillment provider plugin and holds its installation status.",
"type": "object",
"required": [
"id",
"is_installed"
],
"properties": {
"id": {
"description": "The id of the fulfillment provider as given by the plugin.",
"type": "string",
"example": "manual"
},
"is_installed": {
"description": "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.",
"type": "boolean",
"default": true
}
}
},
"GiftCard": {
"title": "Gift Card",
"description": "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.",
"type": "object",
"required": [
"balance",
"code",
"created_at",
"deleted_at",
"ends_at",
"id",
"is_disabled",
"metadata",
"order_id",
"region_id",
"tax_rate",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The gift card's ID",
"type": "string",
"example": "gift_01G8XKBPBQY2R7RBET4J7E0XQZ"
},
"code": {
"description": "The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.",
"type": "string",
"example": "3RFT-MH2C-Y4YZ-XMN4"
},
"value": {
"description": "The value that the Gift Card represents.",
"type": "integer",
"example": 10
},
"balance": {
"description": "The remaining value on the Gift Card.",
"type": "integer",
"example": 10
},
"region_id": {
"description": "The id of the Region in which the Gift Card is available.",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"order_id": {
"description": "The id of the Order that the Gift Card was purchased in.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"is_disabled": {
"description": "Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.",
"type": "boolean",
"default": false
},
"ends_at": {
"description": "The time at which the Gift Card can no longer be used.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"tax_rate": {
"description": "The gift card's tax rate that will be applied on calculating totals",
"nullable": true,
"type": "number",
"example": 0
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"GiftCardTransaction": {
"title": "Gift Card Transaction",
"description": "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order",
"type": "object",
"required": [
"amount",
"created_at",
"gift_card_id",
"id",
"is_taxable",
"order_id",
"tax_rate"
],
"properties": {
"id": {
"description": "The gift card transaction's ID",
"type": "string",
"example": "gct_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"gift_card_id": {
"description": "The ID of the Gift Card that was used in the transaction.",
"type": "string",
"example": "gift_01G8XKBPBQY2R7RBET4J7E0XQZ"
},
"gift_card": {
"description": "A gift card object. Available if the relation `gift_card` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/GiftCard"
},
"order_id": {
"description": "The ID of the Order that the Gift Card was used to pay for.",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"amount": {
"description": "The amount that was used from the Gift Card.",
"type": "integer",
"example": 10
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"is_taxable": {
"description": "Whether the transaction is taxable or not.",
"nullable": true,
"type": "boolean",
"example": false
},
"tax_rate": {
"description": "The tax rate of the transaction",
"nullable": true,
"type": "number",
"example": 0
}
}
},
"IdempotencyKey": {
"title": "Idempotency Key",
"description": "Idempotency Key is used to continue a process in case of any failure that might occur.",
"type": "object",
"required": [
"created_at",
"id",
"idempotency_key",
"locked_at",
"recovery_point",
"response_code",
"response_body",
"request_method",
"request_params",
"request_path"
],
"properties": {
"id": {
"description": "The idempotency key's ID",
"type": "string",
"example": "ikey_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"idempotency_key": {
"description": "The unique randomly generated key used to determine the state of a process.",
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "Date which the idempotency key was locked.",
"type": "string",
"format": "date-time"
},
"locked_at": {
"description": "Date which the idempotency key was locked.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"request_method": {
"description": "The method of the request",
"nullable": true,
"type": "string",
"example": "POST"
},
"request_params": {
"description": "The parameters passed to the request",
"nullable": true,
"type": "object",
"example": {
"id": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
}
},
"request_path": {
"description": "The request's path",
"nullable": true,
"type": "string",
"example": "/store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete"
},
"response_code": {
"description": "The response's code.",
"nullable": true,
"type": "string",
"example": 200
},
"response_body": {
"description": "The response's body",
"nullable": true,
"type": "object",
"example": {
"id": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
}
},
"recovery_point": {
"description": "Where to continue from.",
"type": "string",
"default": "started"
}
}
},
"Image": {
"title": "Image",
"description": "Images holds a reference to a URL at which the image file can be found.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"updated_at",
"url"
],
"properties": {
"id": {
"type": "string",
"description": "The image's ID",
"example": "img_01G749BFYR6T8JTVW6SGW3K3E6"
},
"url": {
"description": "The URL at which the image file can be found.",
"type": "string",
"format": "uri"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"InventoryItemDTO": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"description": "The Stock Keeping Unit (SKU) code of the Inventory Item.",
"type": "string"
},
"hs_code": {
"description": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"type": "string"
},
"origin_country": {
"description": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"type": "string"
},
"mid_code": {
"description": "The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"type": "string"
},
"material": {
"description": "The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"type": "string"
},
"weight": {
"description": "The weight of the Inventory Item. May be used in shipping rate calculations.",
"type": "number"
},
"height": {
"description": "The height of the Inventory Item. May be used in shipping rate calculations.",
"type": "number"
},
"width": {
"description": "The width of the Inventory Item. May be used in shipping rate calculations.",
"type": "number"
},
"length": {
"description": "The length of the Inventory Item. May be used in shipping rate calculations.",
"type": "number"
},
"requires_shipping": {
"description": "Whether the item requires shipping.",
"type": "boolean"
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"description": "The date with timezone at which the resource was deleted.",
"format": "date-time"
}
}
},
"InventoryLevelDTO": {
"type": "object",
"required": [
"inventory_item_id",
"location_id",
"stocked_quantity",
"reserved_quantity",
"incoming_quantity"
],
"properties": {
"location_id": {
"description": "the item location ID",
"type": "string"
},
"stocked_quantity": {
"description": "the total stock quantity of an inventory item at the given location ID",
"type": "number"
},
"reserved_quantity": {
"description": "the reserved stock quantity of an inventory item at the given location ID",
"type": "number"
},
"incoming_quantity": {
"description": "the incoming stock quantity of an inventory item at the given location ID",
"type": "number"
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"description": "The date with timezone at which the resource was deleted.",
"format": "date-time"
}
}
},
"Invite": {
"title": "Invite",
"description": "Represents an invite",
"type": "object",
"required": [
"accepted",
"created_at",
"deleted_at",
"expires_at",
"id",
"metadata",
"role",
"token",
"updated_at",
"user_email"
],
"properties": {
"id": {
"type": "string",
"description": "The invite's ID",
"example": "invite_01G8TKE4XYCTHSCK2GDEP47RE1"
},
"user_email": {
"description": "The email of the user being invited.",
"type": "string",
"format": "email"
},
"role": {
"description": "The user's role.",
"nullable": true,
"type": "string",
"enum": [
"admin",
"member",
"developer"
],
"default": "member"
},
"accepted": {
"description": "Whether the invite was accepted or not.",
"type": "boolean",
"default": false
},
"token": {
"description": "The token used to accept the invite.",
"type": "string"
},
"expires_at": {
"description": "The date the invite expires at.",
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"LineItem": {
"title": "Line Item",
"description": "Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims.",
"type": "object",
"required": [
"allow_discounts",
"cart_id",
"claim_order_id",
"created_at",
"description",
"fulfilled_quantity",
"has_shipping",
"id",
"is_giftcard",
"is_return",
"metadata",
"order_edit_id",
"order_id",
"original_item_id",
"quantity",
"returned_quantity",
"shipped_quantity",
"should_merge",
"swap_id",
"thumbnail",
"title",
"unit_price",
"updated_at",
"variant_id"
],
"properties": {
"id": {
"description": "The line item's ID",
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"cart_id": {
"description": "The ID of the Cart that the Line Item belongs to.",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"order_id": {
"description": "The ID of the Order that the Line Item belongs to.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"swap_id": {
"description": "The id of the Swap that the Line Item belongs to.",
"nullable": true,
"type": "string",
"example": null
},
"swap": {
"description": "A swap object. Available if the relation `swap` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Swap"
},
"claim_order_id": {
"description": "The id of the Claim that the Line Item belongs to.",
"nullable": true,
"type": "string",
"example": null
},
"claim_order": {
"description": "A claim order object. Available if the relation `claim_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimOrder"
},
"tax_lines": {
"description": "Available if the relation `tax_lines` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItemTaxLine"
}
},
"adjustments": {
"description": "Available if the relation `adjustments` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItemAdjustment"
}
},
"original_item_id": {
"description": "The id of the original line item",
"nullable": true,
"type": "string"
},
"order_edit_id": {
"description": "The ID of the order edit to which a cloned item belongs",
"nullable": true,
"type": "string"
},
"order_edit": {
"description": "The order edit joined. Available if the relation `order_edit` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/OrderEdit"
},
"title": {
"description": "The title of the Line Item, this should be easily identifiable by the Customer.",
"type": "string",
"example": "Medusa Coffee Mug"
},
"description": {
"description": "A more detailed description of the contents of the Line Item.",
"nullable": true,
"type": "string",
"example": "One Size"
},
"thumbnail": {
"description": "A URL string to a small image of the contents of the Line Item.",
"nullable": true,
"type": "string",
"format": "uri",
"example": "https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png"
},
"is_return": {
"description": "Is the item being returned",
"type": "boolean",
"default": false
},
"is_giftcard": {
"description": "Flag to indicate if the Line Item is a Gift Card.",
"type": "boolean",
"default": false
},
"should_merge": {
"description": "Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.",
"type": "boolean",
"default": true
},
"allow_discounts": {
"description": "Flag to indicate if the Line Item should be included when doing discount calculations.",
"type": "boolean",
"default": true
},
"has_shipping": {
"description": "Flag to indicate if the Line Item has fulfillment associated with it.",
"nullable": true,
"type": "boolean",
"example": false
},
"unit_price": {
"description": "The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.",
"type": "integer",
"example": 8000
},
"variant_id": {
"description": "The id of the Product Variant contained in the Line Item.",
"nullable": true,
"type": "string",
"example": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6"
},
"variant": {
"description": "A product variant object. The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductVariant"
},
"quantity": {
"description": "The quantity of the content in the Line Item.",
"type": "integer",
"example": 1
},
"fulfilled_quantity": {
"description": "The quantity of the Line Item that has been fulfilled.",
"nullable": true,
"type": "integer",
"example": 0
},
"returned_quantity": {
"description": "The quantity of the Line Item that has been returned.",
"nullable": true,
"type": "integer",
"example": 0
},
"shipped_quantity": {
"description": "The quantity of the Line Item that has been shipped.",
"nullable": true,
"type": "integer",
"example": 0
},
"refundable": {
"description": "The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.",
"type": "integer",
"example": 0
},
"subtotal": {
"description": "The subtotal of the line item",
"type": "integer",
"example": 8000
},
"tax_total": {
"description": "The total of tax of the line item",
"type": "integer",
"example": 0
},
"total": {
"description": "The total amount of the line item",
"type": "integer",
"example": 8000
},
"original_total": {
"description": "The original total amount of the line item",
"type": "integer",
"example": 8000
},
"original_tax_total": {
"description": "The original tax total amount of the line item",
"type": "integer",
"example": 0
},
"discount_total": {
"description": "The total of discount of the line item rounded",
"type": "integer",
"example": 0
},
"raw_discount_total": {
"description": "The total of discount of the line item",
"type": "integer",
"example": 0
},
"gift_card_total": {
"description": "The total of the gift card of the line item",
"type": "integer",
"example": 0
},
"includes_tax": {
"description": "[EXPERIMENTAL] Indicates if the line item unit_price include tax",
"type": "boolean",
"default": false
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"LineItemAdjustment": {
"title": "Line Item Adjustment",
"description": "Represents a Line Item Adjustment",
"type": "object",
"required": [
"amount",
"description",
"discount_id",
"id",
"item_id",
"metadata"
],
"properties": {
"id": {
"description": "The Line Item Adjustment's ID",
"type": "string",
"example": "lia_01G8TKE4XYCTHSCK2GDEP47RE1"
},
"item_id": {
"description": "The ID of the line item",
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"item": {
"description": "Available if the relation `item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"description": {
"description": "The line item's adjustment description",
"type": "string",
"example": "Adjusted item's price."
},
"discount_id": {
"description": "The ID of the discount associated with the adjustment",
"nullable": true,
"type": "string",
"example": "disc_01F0YESMW10MGHWJKZSDDMN0VN"
},
"discount": {
"description": "Available if the relation `discount` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Discount"
},
"amount": {
"description": "The adjustment amount",
"type": "number",
"example": 1000
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"LineItemTaxLine": {
"title": "Line Item Tax Line",
"description": "Represents a Line Item Tax Line",
"type": "object",
"required": [
"code",
"created_at",
"id",
"item_id",
"metadata",
"name",
"rate",
"updated_at"
],
"properties": {
"id": {
"description": "The line item tax line's ID",
"type": "string",
"example": "litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8"
},
"code": {
"description": "A code to identify the tax type by",
"nullable": true,
"type": "string",
"example": "tax01"
},
"name": {
"description": "A human friendly name for the tax",
"type": "string",
"example": "Tax Example"
},
"rate": {
"description": "The numeric rate to charge tax by",
"type": "number",
"example": 10
},
"item_id": {
"description": "The ID of the line item",
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"item": {
"description": "Available if the relation `item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ModulesResponse": {
"type": "array",
"items": {
"type": "object",
"required": [
"module",
"resolution"
],
"properties": {
"module": {
"description": "The key of the module.",
"type": "string"
},
"resolution": {
"description": "The resolution path of the module or false if module is not installed.",
"type": "string"
}
}
}
},
"MoneyAmount": {
"title": "Money Amount",
"description": "Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon.",
"type": "object",
"required": [
"amount",
"created_at",
"currency_code",
"deleted_at",
"id",
"max_quantity",
"min_quantity",
"price_list_id",
"region_id",
"updated_at",
"variant_id"
],
"properties": {
"id": {
"description": "The money amount's ID",
"type": "string",
"example": "ma_01F0YESHRFQNH5S8Q0PK84YYZN"
},
"currency_code": {
"description": "The 3 character currency code that the Money Amount is given in.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"currency": {
"description": "Available if the relation `currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"amount": {
"description": "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.",
"type": "integer",
"example": 100
},
"min_quantity": {
"description": "The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"nullable": true,
"type": "integer",
"example": 1
},
"max_quantity": {
"description": "The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.",
"nullable": true,
"type": "integer",
"example": 1
},
"price_list_id": {
"description": "The ID of the price list associated with the money amount",
"nullable": true,
"type": "string",
"example": "pl_01G8X3CKJXCG5VXVZ87H9KC09W"
},
"price_list": {
"description": "Available if the relation `price_list` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/PriceList"
},
"variant_id": {
"description": "The id of the Product Variant contained in the Line Item.",
"nullable": true,
"type": "string",
"example": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6"
},
"variant": {
"description": "The Product Variant contained in the Line Item. Available if the relation `variant` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductVariant"
},
"region_id": {
"description": "The region's ID",
"nullable": true,
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"MultipleErrors": {
"title": "Multiple Errors",
"type": "object",
"properties": {
"errors": {
"type": "array",
"description": "Array of errors",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"message": {
"type": "string",
"default": "Provided request body contains errors. Please check the data and retry the request"
}
}
},
"Note": {
"title": "Note",
"description": "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these.",
"type": "object",
"required": [
"author_id",
"created_at",
"deleted_at",
"id",
"metadata",
"resource_id",
"resource_type",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The note's ID",
"type": "string",
"example": "note_01G8TM8ENBMC7R90XRR1G6H26Q"
},
"resource_type": {
"description": "The type of resource that the Note refers to.",
"type": "string",
"example": "order"
},
"resource_id": {
"description": "The ID of the resource that the Note refers to.",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"value": {
"description": "The contents of the note.",
"type": "string",
"example": "This order must be fulfilled on Monday"
},
"author_id": {
"description": "The ID of the author (user)",
"nullable": true,
"type": "string",
"example": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V"
},
"author": {
"description": "Available if the relation `author` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/User"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Notification": {
"title": "Notification",
"description": "Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends.",
"type": "object",
"required": [
"created_at",
"customer_id",
"data",
"event_name",
"id",
"parent_id",
"provider_id",
"resource_type",
"resource_id",
"to",
"updated_at"
],
"properties": {
"id": {
"description": "The notification's ID",
"type": "string",
"example": "noti_01G53V9Y6CKMCGBM1P0X7C28RX"
},
"event_name": {
"description": "The name of the event that the notification was sent for.",
"nullable": true,
"type": "string",
"example": "order.placed"
},
"resource_type": {
"description": "The type of resource that the Notification refers to.",
"type": "string",
"example": "order"
},
"resource_id": {
"description": "The ID of the resource that the Notification refers to.",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"customer_id": {
"description": "The ID of the Customer that the Notification was sent to.",
"nullable": true,
"type": "string",
"example": "cus_01G2SG30J8C85S4A5CHM2S1NS2"
},
"customer": {
"description": "A customer object. Available if the relation `customer` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Customer"
},
"to": {
"description": "The address that the Notification was sent to. This will usually be an email address, but represent other addresses such as a chat bot user id",
"type": "string",
"example": "user@example.com"
},
"data": {
"description": "The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.",
"type": "object",
"example": {}
},
"parent_id": {
"description": "The notification's parent ID",
"nullable": true,
"type": "string",
"example": "noti_01G53V9Y6CKMCGBM1P0X7C28RX"
},
"parent_notification": {
"description": "Available if the relation `parent_notification` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Notification"
},
"resends": {
"description": "The resends that have been completed after the original Notification. Available if the relation `resends` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Notification"
}
},
"provider_id": {
"description": "The id of the Notification Provider that handles the Notification.",
"nullable": true,
"type": "string",
"example": "sengrid"
},
"provider": {
"description": "Available if the relation `provider` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/NotificationProvider"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
}
}
},
"NotificationProvider": {
"title": "Notification Provider",
"description": "Represents a notification provider plugin and holds its installation status.",
"type": "object",
"required": [
"id",
"is_installed"
],
"properties": {
"id": {
"description": "The id of the notification provider as given by the plugin.",
"type": "string",
"example": "sendgrid"
},
"is_installed": {
"description": "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.",
"type": "boolean",
"default": true
}
}
},
"OAuth": {
"title": "OAuth",
"description": "Represent an OAuth app",
"type": "object",
"required": [
"application_name",
"data",
"display_name",
"id",
"install_url",
"uninstall_url"
],
"properties": {
"id": {
"description": "The app's ID",
"type": "string",
"example": "example_app"
},
"display_name": {
"description": "The app's display name",
"type": "string",
"example": "Example app"
},
"application_name": {
"description": "The app's name",
"type": "string",
"example": "example"
},
"install_url": {
"description": "The URL to install the app",
"nullable": true,
"type": "string",
"format": "uri"
},
"uninstall_url": {
"description": "The URL to uninstall the app",
"nullable": true,
"type": "string",
"format": "uri"
},
"data": {
"description": "Any data necessary to the app.",
"nullable": true,
"type": "object",
"example": {}
}
}
},
"Order": {
"title": "Order",
"description": "Represents an order",
"type": "object",
"required": [
"billing_address_id",
"canceled_at",
"cart_id",
"created_at",
"currency_code",
"customer_id",
"draft_order_id",
"display_id",
"email",
"external_id",
"fulfillment_status",
"id",
"idempotency_key",
"metadata",
"no_notification",
"object",
"payment_status",
"region_id",
"shipping_address_id",
"status",
"tax_rate",
"updated_at"
],
"properties": {
"id": {
"description": "The order's ID",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"status": {
"description": "The order's status",
"type": "string",
"enum": [
"pending",
"completed",
"archived",
"canceled",
"requires_action"
],
"default": "pending"
},
"fulfillment_status": {
"description": "The order's fulfillment status",
"type": "string",
"enum": [
"not_fulfilled",
"partially_fulfilled",
"fulfilled",
"partially_shipped",
"shipped",
"partially_returned",
"returned",
"canceled",
"requires_action"
],
"default": "not_fulfilled"
},
"payment_status": {
"description": "The order's payment status",
"type": "string",
"enum": [
"not_paid",
"awaiting",
"captured",
"partially_refunded",
"refunded",
"canceled",
"requires_action"
],
"default": "not_paid"
},
"display_id": {
"description": "The order's display ID",
"type": "integer",
"example": 2
},
"cart_id": {
"description": "The ID of the cart associated with the order",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"customer_id": {
"description": "The ID of the customer associated with the order",
"type": "string",
"example": "cus_01G2SG30J8C85S4A5CHM2S1NS2"
},
"customer": {
"description": "A customer object. Available if the relation `customer` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Customer"
},
"email": {
"description": "The email associated with the order",
"type": "string",
"format": "email"
},
"billing_address_id": {
"description": "The ID of the billing address associated with the order",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"billing_address": {
"description": "Available if the relation `billing_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"shipping_address_id": {
"description": "The ID of the shipping address associated with the order",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"shipping_address": {
"description": "Available if the relation `shipping_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"region_id": {
"description": "The region's ID",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"currency_code": {
"description": "The 3 character currency code that is used in the order",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"currency": {
"description": "Available if the relation `currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"tax_rate": {
"description": "The order's tax rate",
"nullable": true,
"type": "number",
"example": 0
},
"discounts": {
"description": "The discounts used in the order. Available if the relation `discounts` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Discount"
}
},
"gift_cards": {
"description": "The gift cards used in the order. Available if the relation `gift_cards` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/GiftCard"
}
},
"shipping_methods": {
"description": "The shipping methods used in the order. Available if the relation `shipping_methods` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMethod"
}
},
"payments": {
"description": "The payments used in the order. Available if the relation `payments` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
},
"fulfillments": {
"description": "The fulfillments used in the order. Available if the relation `fulfillments` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Fulfillment"
}
},
"returns": {
"description": "The returns associated with the order. Available if the relation `returns` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Return"
}
},
"claims": {
"description": "The claims associated with the order. Available if the relation `claims` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ClaimOrder"
}
},
"refunds": {
"description": "The refunds associated with the order. Available if the relation `refunds` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Refund"
}
},
"swaps": {
"description": "The swaps associated with the order. Available if the relation `swaps` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Swap"
}
},
"draft_order_id": {
"description": "The ID of the draft order this order is associated with.",
"nullable": true,
"type": "string",
"example": null
},
"draft_order": {
"description": "A draft order object. Available if the relation `draft_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/DraftOrder"
},
"items": {
"description": "The line items that belong to the order. Available if the relation `items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"edits": {
"description": "Order edits done on the order. Available if the relation `edits` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderEdit"
}
},
"gift_card_transactions": {
"description": "The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/GiftCardTransaction"
}
},
"canceled_at": {
"description": "The date the order was canceled on.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"no_notification": {
"description": "Flag for describing whether or not notifications related to this should be send.",
"nullable": true,
"type": "boolean",
"example": false
},
"idempotency_key": {
"description": "Randomly generated key used to continue the processing of the order in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"external_id": {
"description": "The ID of an external order.",
"nullable": true,
"type": "string",
"example": null
},
"sales_channel_id": {
"description": "The ID of the sales channel this order is associated with.",
"nullable": true,
"type": "string",
"example": null
},
"sales_channel": {
"description": "A sales channel object. Available if the relation `sales_channel` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/SalesChannel"
},
"shipping_total": {
"type": "integer",
"description": "The total of shipping",
"example": 1000
},
"raw_discount_total": {
"description": "The total of discount",
"type": "integer",
"example": 800
},
"discount_total": {
"description": "The total of discount rounded",
"type": "integer",
"example": 800
},
"tax_total": {
"description": "The total of tax",
"type": "integer",
"example": 0
},
"refunded_total": {
"description": "The total amount refunded if the order is returned.",
"type": "integer",
"example": 0
},
"total": {
"description": "The total amount of the order",
"type": "integer",
"example": 8200
},
"subtotal": {
"description": "The subtotal of the order",
"type": "integer",
"example": 8000
},
"paid_total": {
"description": "The total amount paid",
"type": "integer",
"example": 8000
},
"refundable_amount": {
"description": "The amount that can be refunded",
"type": "integer",
"example": 8200
},
"gift_card_total": {
"description": "The total of gift cards",
"type": "integer",
"example": 0
},
"gift_card_tax_total": {
"description": "The total of gift cards with taxes",
"type": "integer",
"example": 0
},
"returnable_items": {
"description": "The items that are returnable as part of the order, order swaps or order claims",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"OrderEdit": {
"title": "Order Edit",
"description": "Order edit keeps track of order items changes.",
"type": "object",
"required": [
"canceled_at",
"canceled_by",
"confirmed_by",
"confirmed_at",
"created_at",
"created_by",
"declined_at",
"declined_by",
"declined_reason",
"id",
"internal_note",
"order_id",
"payment_collection_id",
"requested_at",
"requested_by",
"status",
"updated_at"
],
"properties": {
"id": {
"description": "The order edit's ID",
"type": "string",
"example": "oe_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order_id": {
"description": "The ID of the order that is edited",
"type": "string",
"example": "order_01G2SG30J8C85S4A5CHM2S1NS2"
},
"order": {
"description": "Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"changes": {
"description": "Available if the relation `changes` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderItemChange"
}
},
"internal_note": {
"description": "An optional note with additional details about the order edit.",
"nullable": true,
"type": "string",
"example": "Included two more items B to the order."
},
"created_by": {
"description": "The unique identifier of the user or customer who created the order edit.",
"type": "string"
},
"requested_by": {
"description": "The unique identifier of the user or customer who requested the order edit.",
"nullable": true,
"type": "string"
},
"requested_at": {
"description": "The date with timezone at which the edit was requested.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"confirmed_by": {
"description": "The unique identifier of the user or customer who confirmed the order edit.",
"nullable": true,
"type": "string"
},
"confirmed_at": {
"description": "The date with timezone at which the edit was confirmed.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"declined_by": {
"description": "The unique identifier of the user or customer who declined the order edit.",
"nullable": true,
"type": "string"
},
"declined_at": {
"description": "The date with timezone at which the edit was declined.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"declined_reason": {
"description": "An optional note why the order edit is declined.",
"nullable": true,
"type": "string"
},
"canceled_by": {
"description": "The unique identifier of the user or customer who cancelled the order edit.",
"nullable": true,
"type": "string"
},
"canceled_at": {
"description": "The date with timezone at which the edit was cancelled.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"subtotal": {
"description": "The total of subtotal",
"type": "integer",
"example": 8000
},
"discount_total": {
"description": "The total of discount",
"type": "integer",
"example": 800
},
"shipping_total": {
"description": "The total of the shipping amount",
"type": "integer",
"example": 800
},
"gift_card_total": {
"description": "The total of the gift card amount",
"type": "integer",
"example": 800
},
"gift_card_tax_total": {
"description": "The total of the gift card tax amount",
"type": "integer",
"example": 800
},
"tax_total": {
"description": "The total of tax",
"type": "integer",
"example": 0
},
"total": {
"description": "The total amount of the edited order.",
"type": "integer",
"example": 8200
},
"difference_due": {
"description": "The difference between the total amount of the order and total amount of edited order.",
"type": "integer",
"example": 8200
},
"status": {
"description": "The status of the order edit.",
"type": "string",
"enum": [
"confirmed",
"declined",
"requested",
"created",
"canceled"
]
},
"items": {
"description": "Available if the relation `items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"payment_collection_id": {
"description": "The ID of the payment collection",
"nullable": true,
"type": "string",
"example": "paycol_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"payment_collection": {
"description": "Available if the relation `payment_collection` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/PaymentCollection"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
}
}
},
"OrderItemChange": {
"title": "Order Item Change",
"description": "Represents an order edit item change",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"line_item_id",
"order_edit_id",
"original_line_item_id",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The order item change's ID",
"type": "string",
"example": "oic_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"type": {
"description": "The order item change's status",
"type": "string",
"enum": [
"item_add",
"item_remove",
"item_update"
]
},
"order_edit_id": {
"description": "The ID of the order edit",
"type": "string",
"example": "oe_01G2SG30J8C85S4A5CHM2S1NS2"
},
"order_edit": {
"description": "Available if the relation `order_edit` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/OrderEdit"
},
"original_line_item_id": {
"description": "The ID of the original line item in the order",
"nullable": true,
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"original_line_item": {
"description": "Available if the relation `original_line_item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"line_item_id": {
"description": "The ID of the cloned line item.",
"nullable": true,
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"line_item": {
"description": "Available if the relation `line_item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"Payment": {
"title": "Payment",
"description": "Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded.",
"type": "object",
"required": [
"amount",
"amount_refunded",
"canceled_at",
"captured_at",
"cart_id",
"created_at",
"currency_code",
"data",
"id",
"idempotency_key",
"metadata",
"order_id",
"provider_id",
"swap_id",
"updated_at"
],
"properties": {
"id": {
"description": "The payment's ID",
"type": "string",
"example": "pay_01G2SJNT6DEEWDFNAJ4XWDTHKE"
},
"swap_id": {
"description": "The ID of the Swap that the Payment is used for.",
"nullable": true,
"type": "string",
"example": null
},
"swap": {
"description": "A swap object. Available if the relation `swap` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Swap"
},
"cart_id": {
"description": "The id of the Cart that the Payment Session is created for.",
"nullable": true,
"type": "string"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"order_id": {
"description": "The ID of the Order that the Payment is used for.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"amount": {
"description": "The amount that the Payment has been authorized for.",
"type": "integer",
"example": 100
},
"currency_code": {
"description": "The 3 character ISO currency code that the Payment is completed in.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"currency": {
"description": "Available if the relation `currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"amount_refunded": {
"description": "The amount of the original Payment amount that has been refunded back to the Customer.",
"type": "integer",
"default": 0,
"example": 0
},
"provider_id": {
"description": "The id of the Payment Provider that is responsible for the Payment",
"type": "string",
"example": "manual"
},
"data": {
"description": "The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"type": "object",
"example": {}
},
"captured_at": {
"description": "The date with timezone at which the Payment was captured.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"canceled_at": {
"description": "The date with timezone at which the Payment was canceled.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of a payment in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"PaymentCollection": {
"title": "Payment Collection",
"description": "Payment Collection",
"type": "object",
"required": [
"amount",
"authorized_amount",
"created_at",
"created_by",
"currency_code",
"deleted_at",
"description",
"id",
"metadata",
"region_id",
"status",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The payment collection's ID",
"type": "string",
"example": "paycol_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"type": {
"description": "The type of the payment collection",
"type": "string",
"enum": [
"order_edit"
]
},
"status": {
"description": "The type of the payment collection",
"type": "string",
"enum": [
"not_paid",
"awaiting",
"authorized",
"partially_authorized",
"canceled"
]
},
"description": {
"description": "Description of the payment collection",
"nullable": true,
"type": "string"
},
"amount": {
"description": "Amount of the payment collection.",
"type": "integer"
},
"authorized_amount": {
"description": "Authorized amount of the payment collection.",
"nullable": true,
"type": "integer"
},
"region_id": {
"description": "The region's ID",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"currency_code": {
"description": "The 3 character ISO code for the currency.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"currency": {
"description": "Available if the relation `currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"payment_sessions": {
"description": "Available if the relation `payment_sessions` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentSession"
}
},
"payments": {
"description": "Available if the relation `payments` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
}
},
"created_by": {
"description": "The ID of the user that created the payment collection.",
"type": "string"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"PaymentProvider": {
"title": "Payment Provider",
"description": "Represents a Payment Provider plugin and holds its installation status.",
"type": "object",
"required": [
"id",
"is_installed"
],
"properties": {
"id": {
"description": "The id of the payment provider as given by the plugin.",
"type": "string",
"example": "manual"
},
"is_installed": {
"description": "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.",
"type": "boolean",
"default": true
}
}
},
"PaymentSession": {
"title": "Payment Session",
"description": "Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc.",
"type": "object",
"required": [
"amount",
"cart_id",
"created_at",
"data",
"id",
"is_initiated",
"is_selected",
"idempotency_key",
"payment_authorized_at",
"provider_id",
"status",
"updated_at"
],
"properties": {
"id": {
"description": "The payment session's ID",
"type": "string",
"example": "ps_01G901XNSRM2YS3ASN9H5KG3FZ"
},
"cart_id": {
"description": "The id of the Cart that the Payment Session is created for.",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"provider_id": {
"description": "The id of the Payment Provider that is responsible for the Payment Session",
"type": "string",
"example": "manual"
},
"is_selected": {
"description": "A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.",
"nullable": true,
"type": "boolean",
"example": true
},
"is_initiated": {
"description": "A flag to indicate if a communication with the third party provider has been initiated.",
"type": "boolean",
"default": false,
"example": true
},
"status": {
"description": "Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.",
"type": "string",
"enum": [
"authorized",
"pending",
"requires_more",
"error",
"canceled"
],
"example": "pending"
},
"data": {
"description": "The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.",
"type": "object",
"example": {}
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of a cart in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"amount": {
"description": "The amount that the Payment Session has been authorized for.",
"nullable": true,
"type": "integer",
"example": 100
},
"payment_authorized_at": {
"description": "The date with timezone at which the Payment Session was authorized.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
}
}
},
"PriceList": {
"title": "Price List",
"description": "Price Lists represents a set of prices that overrides the default price for one or more product variants.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"description",
"ends_at",
"id",
"name",
"starts_at",
"status",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The price list's ID",
"type": "string",
"example": "pl_01G8X3CKJXCG5VXVZ87H9KC09W"
},
"name": {
"description": "The price list's name",
"type": "string",
"example": "VIP Prices"
},
"description": {
"description": "The price list's description",
"type": "string",
"example": "Prices for VIP customers"
},
"type": {
"description": "The type of Price List. This can be one of either `sale` or `override`.",
"type": "string",
"enum": [
"sale",
"override"
],
"default": "sale"
},
"status": {
"description": "The status of the Price List",
"type": "string",
"enum": [
"active",
"draft"
],
"default": "draft"
},
"starts_at": {
"description": "The date with timezone that the Price List starts being valid.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"ends_at": {
"description": "The date with timezone that the Price List stops being valid.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"customer_groups": {
"description": "The Customer Groups that the Price List applies to. Available if the relation `customer_groups` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerGroup"
}
},
"prices": {
"description": "The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MoneyAmount"
}
},
"includes_tax": {
"description": "[EXPERIMENTAL] Does the price list prices include tax",
"type": "boolean",
"default": false
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"PricedProduct": {
"title": "Priced Product",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Product"
},
{
"type": "object",
"properties": {
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricedVariant"
}
}
}
}
]
},
"PricedShippingOption": {
"title": "Priced Shipping Option",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ShippingOption"
},
{
"type": "object",
"properties": {
"price_incl_tax": {
"type": "number",
"description": "Price including taxes"
},
"tax_rates": {
"type": "array",
"description": "An array of applied tax rates",
"items": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "The tax rate value"
},
"name": {
"type": "string",
"description": "The name of the tax rate"
},
"code": {
"type": "string",
"description": "The code of the tax rate"
}
}
}
},
"tax_amount": {
"type": "number",
"description": "The taxes applied."
}
}
}
]
},
"PricedVariant": {
"title": "Priced Product Variant",
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/ProductVariant"
},
{
"type": "object",
"properties": {
"original_price": {
"type": "number",
"description": "The original price of the variant without any discounted prices applied."
},
"calculated_price": {
"type": "number",
"description": "The calculated price of the variant. Can be a discounted price."
},
"original_price_incl_tax": {
"type": "number",
"description": "The original price of the variant including taxes."
},
"calculated_price_incl_tax": {
"type": "number",
"description": "The calculated price of the variant including taxes."
},
"original_tax": {
"type": "number",
"description": "The taxes applied on the original price."
},
"calculated_tax": {
"type": "number",
"description": "The taxes applied on the calculated price."
},
"tax_rates": {
"type": "array",
"description": "An array of applied tax rates",
"items": {
"type": "object",
"properties": {
"rate": {
"type": "number",
"description": "The tax rate value"
},
"name": {
"type": "string",
"description": "The name of the tax rate"
},
"code": {
"type": "string",
"description": "The code of the tax rate"
}
}
}
}
}
}
]
},
"Product": {
"title": "Product",
"description": "Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by.",
"type": "object",
"required": [
"collection_id",
"created_at",
"deleted_at",
"description",
"discountable",
"external_id",
"handle",
"height",
"hs_code",
"id",
"is_giftcard",
"length",
"material",
"metadata",
"mid_code",
"origin_country",
"profile_id",
"status",
"subtitle",
"type_id",
"thumbnail",
"title",
"updated_at",
"weight",
"width"
],
"properties": {
"id": {
"description": "The product's ID",
"type": "string",
"example": "prod_01G1G5V2MBA328390B5AXJ610F"
},
"title": {
"description": "A title that can be displayed for easy identification of the Product.",
"type": "string",
"example": "Medusa Coffee Mug"
},
"subtitle": {
"description": "An optional subtitle that can be used to further specify the Product.",
"nullable": true,
"type": "string"
},
"description": {
"description": "A short description of the Product.",
"nullable": true,
"type": "string",
"example": "Every programmer's best friend."
},
"handle": {
"description": "A unique identifier for the Product (e.g. for slug structure).",
"nullable": true,
"type": "string",
"example": "coffee-mug"
},
"is_giftcard": {
"description": "Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.",
"type": "boolean",
"default": false
},
"status": {
"description": "The status of the product",
"type": "string",
"enum": [
"draft",
"proposed",
"published",
"rejected"
],
"default": "draft"
},
"images": {
"description": "Images of the Product. Available if the relation `images` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"thumbnail": {
"description": "A URL to an image file that can be used to identify the Product.",
"nullable": true,
"type": "string",
"format": "uri"
},
"options": {
"description": "The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOption"
}
},
"variants": {
"description": "The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariant"
}
},
"categories": {
"description": "The product's associated categories. Available if the relation `categories` are expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCategory"
}
},
"profile_id": {
"description": "The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.",
"type": "string",
"example": "sp_01G1G5V239ENSZ5MV4JAR737BM"
},
"profile": {
"description": "Available if the relation `profile` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingProfile"
},
"weight": {
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"length": {
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"height": {
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"width": {
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"hs_code": {
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"origin_country": {
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"mid_code": {
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"material": {
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"collection_id": {
"description": "The Product Collection that the Product belongs to",
"nullable": true,
"type": "string",
"example": "pcol_01F0YESBFAZ0DV6V831JXWH0BG"
},
"collection": {
"description": "A product collection object. Available if the relation `collection` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductCollection"
},
"type_id": {
"description": "The Product type that the Product belongs to",
"nullable": true,
"type": "string",
"example": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"type": {
"description": "Available if the relation `type` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductType"
},
"tags": {
"description": "The Product Tags assigned to the Product. Available if the relation `tags` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductTag"
}
},
"discountable": {
"description": "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.",
"type": "boolean",
"default": true
},
"external_id": {
"description": "The external ID of the product",
"nullable": true,
"type": "string",
"example": null
},
"sales_channels": {
"description": "The sales channels the product is associated with. Available if the relation `sales_channels` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesChannel"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductCategory": {
"title": "ProductCategory",
"description": "Represents a product category",
"x-resourceId": "ProductCategory",
"type": "object",
"required": [
"category_children",
"created_at",
"handle",
"id",
"is_active",
"is_internal",
"mpath",
"name",
"parent_category_id",
"updated_at"
],
"properties": {
"id": {
"description": "The product category's ID",
"type": "string",
"example": "pcat_01G2SG30J8C85S4A5CHM2S1NS2"
},
"name": {
"description": "The product category's name",
"type": "string",
"example": "Regular Fit"
},
"handle": {
"description": "A unique string that identifies the Product Category - can for example be used in slug structures.",
"type": "string",
"example": "regular-fit"
},
"mpath": {
"description": "A string for Materialized Paths - used for finding ancestors and descendents",
"nullable": true,
"type": "string",
"example": "pcat_id1.pcat_id2.pcat_id3"
},
"is_internal": {
"type": "boolean",
"description": "A flag to make product category an internal category for admins",
"default": false
},
"is_active": {
"type": "boolean",
"description": "A flag to make product category visible/hidden in the store front",
"default": false
},
"rank": {
"type": "integer",
"description": "An integer that depicts the rank of category in a tree node",
"default": 0
},
"category_children": {
"description": "Available if the relation `category_children` are expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCategory"
}
},
"parent_category_id": {
"description": "The ID of the parent category.",
"nullable": true,
"type": "string",
"default": null
},
"parent_category": {
"description": "A product category object. Available if the relation `parent_category` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductCategory"
},
"products": {
"description": "Products associated with category. Available if the relation `products` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
}
}
},
"ProductCollection": {
"title": "Product Collection",
"description": "Product Collections represents a group of Products that are related.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"handle",
"id",
"metadata",
"title",
"updated_at"
],
"properties": {
"id": {
"description": "The product collection's ID",
"type": "string",
"example": "pcol_01F0YESBFAZ0DV6V831JXWH0BG"
},
"title": {
"description": "The title that the Product Collection is identified by.",
"type": "string",
"example": "Summer Collection"
},
"handle": {
"description": "A unique string that identifies the Product Collection - can for example be used in slug structures.",
"nullable": true,
"type": "string",
"example": "summer-collection"
},
"products": {
"description": "The Products contained in the Product Collection. Available if the relation `products` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductOption": {
"title": "Product Option",
"description": "Product Options define properties that may vary between different variants of a Product. Common Product Options are \"Size\" and \"Color\", but Medusa doesn't limit what Product Options that can be defined.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"product_id",
"title",
"updated_at"
],
"properties": {
"id": {
"description": "The product option's ID",
"type": "string",
"example": "opt_01F0YESHQBZVKCEXJ24BS6PCX3"
},
"title": {
"description": "The title that the Product Option is defined by (e.g. `Size`).",
"type": "string",
"example": "Size"
},
"values": {
"description": "The Product Option Values that are defined for the Product Option. Available if the relation `values` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOptionValue"
}
},
"product_id": {
"description": "The ID of the Product that the Product Option is defined for.",
"type": "string",
"example": "prod_01G1G5V2MBA328390B5AXJ610F"
},
"product": {
"description": "A product object. Available if the relation `product` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Product"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductOptionValue": {
"title": "Product Option Value",
"description": "A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"option_id",
"updated_at",
"value",
"variant_id"
],
"properties": {
"id": {
"description": "The product option value's ID",
"type": "string",
"example": "optval_01F0YESHR7S6ECD03RF6W12DSJ"
},
"value": {
"description": "The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is \\\"Size\\\" this value could be `Small`, `Medium` or `Large`).",
"type": "string",
"example": "large"
},
"option_id": {
"description": "The ID of the Product Option that the Product Option Value is defined for.",
"type": "string",
"example": "opt_01F0YESHQBZVKCEXJ24BS6PCX3"
},
"option": {
"description": "Available if the relation `option` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductOption"
},
"variant_id": {
"description": "The ID of the Product Variant that the Product Option Value is defined for.",
"type": "string",
"example": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6"
},
"variant": {
"description": "Available if the relation `variant` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductVariant"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductTag": {
"title": "Product Tag",
"description": "Product Tags can be added to Products for easy filtering and grouping.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The product tag's ID",
"type": "string",
"example": "ptag_01G8K2MTMG9168F2B70S1TAVK3"
},
"value": {
"description": "The value that the Product Tag represents",
"type": "string",
"example": "Pants"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductTaxRate": {
"title": "Product Tax Rate",
"description": "Associates a tax rate with a product to indicate that the product is taxed in a certain way",
"type": "object",
"required": [
"created_at",
"metadata",
"product_id",
"rate_id",
"updated_at"
],
"properties": {
"product_id": {
"description": "The ID of the Product",
"type": "string",
"example": "prod_01G1G5V2MBA328390B5AXJ610F"
},
"product": {
"description": "Available if the relation `product` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Product"
},
"rate_id": {
"description": "The ID of the Tax Rate",
"type": "string",
"example": "txr_01G8XDBAWKBHHJRKH0AV02KXBR"
},
"tax_rate": {
"description": "Available if the relation `tax_rate` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/TaxRate"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductType": {
"title": "Product Type",
"description": "Product Type can be added to Products for filtering and reporting purposes.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The product type's ID",
"type": "string",
"example": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"value": {
"description": "The value that the Product Type represents.",
"type": "string",
"example": "Clothing"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductTypeTaxRate": {
"title": "Product Type Tax Rate",
"description": "Associates a tax rate with a product type to indicate that the product type is taxed in a certain way",
"type": "object",
"required": [
"created_at",
"metadata",
"product_type_id",
"rate_id",
"updated_at"
],
"properties": {
"product_type_id": {
"description": "The ID of the Product type",
"type": "string",
"example": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"product_type": {
"description": "Available if the relation `product_type` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductType"
},
"rate_id": {
"description": "The id of the Tax Rate",
"type": "string",
"example": "txr_01G8XDBAWKBHHJRKH0AV02KXBR"
},
"tax_rate": {
"description": "Available if the relation `tax_rate` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/TaxRate"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ProductVariant": {
"title": "Product Variant",
"description": "Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations.",
"type": "object",
"required": [
"allow_backorder",
"barcode",
"created_at",
"deleted_at",
"ean",
"height",
"hs_code",
"id",
"inventory_quantity",
"length",
"manage_inventory",
"material",
"metadata",
"mid_code",
"origin_country",
"product_id",
"sku",
"title",
"upc",
"updated_at",
"weight",
"width"
],
"properties": {
"id": {
"description": "The product variant's ID",
"type": "string",
"example": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6"
},
"title": {
"description": "A title that can be displayed for easy identification of the Product Variant.",
"type": "string",
"example": "Small"
},
"product_id": {
"description": "The ID of the Product that the Product Variant belongs to.",
"type": "string",
"example": "prod_01G1G5V2MBA328390B5AXJ610F"
},
"product": {
"description": "A product object. Available if the relation `product` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Product"
},
"prices": {
"description": "The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/MoneyAmount"
}
},
"sku": {
"description": "The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems.",
"nullable": true,
"type": "string",
"example": "shirt-123"
},
"barcode": {
"description": "A generic field for a GTIN number that can be used to identify the Product Variant.",
"nullable": true,
"type": "string",
"example": null
},
"ean": {
"description": "An EAN barcode number that can be used to identify the Product Variant.",
"nullable": true,
"type": "string",
"example": null
},
"upc": {
"description": "A UPC barcode number that can be used to identify the Product Variant.",
"nullable": true,
"type": "string",
"example": null
},
"variant_rank": {
"description": "The ranking of this variant",
"nullable": true,
"type": "number",
"default": 0
},
"inventory_quantity": {
"description": "The current quantity of the item that is stocked.",
"type": "integer",
"example": 100
},
"allow_backorder": {
"description": "Whether the Product Variant should be purchasable when `inventory_quantity` is 0.",
"type": "boolean",
"default": false
},
"manage_inventory": {
"description": "Whether Medusa should manage inventory for the Product Variant.",
"type": "boolean",
"default": true
},
"hs_code": {
"description": "The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"origin_country": {
"description": "The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"mid_code": {
"description": "The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"material": {
"description": "The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.",
"nullable": true,
"type": "string",
"example": null
},
"weight": {
"description": "The weight of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"length": {
"description": "The length of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"height": {
"description": "The height of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"width": {
"description": "The width of the Product Variant. May be used in shipping rate calculations.",
"nullable": true,
"type": "number",
"example": null
},
"options": {
"description": "The Product Option Values specified for the Product Variant. Available if the relation `options` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOptionValue"
}
},
"inventory_items": {
"description": "The Inventory Items related to the product variant. Available if the relation `inventory_items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductVariantInventoryItem"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
},
"purchasable": {
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
"type": "boolean"
}
}
},
"ProductVariantInventoryItem": {
"title": "Product Variant Inventory Item",
"description": "Product Variant Inventory Items link variants with inventory items and denote the number of inventory items constituting a variant.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"inventory_item_id",
"required_quantity",
"updated_at",
"variant_id"
],
"properties": {
"id": {
"description": "The product variant inventory item's ID",
"type": "string",
"example": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"inventory_item_id": {
"description": "The id of the inventory item",
"type": "string"
},
"variant_id": {
"description": "The id of the variant.",
"type": "string"
},
"variant": {
"description": "A ProductVariant object. Available if the relation `variant` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ProductVariant"
},
"required_quantity": {
"description": "The quantity of an inventory item required for one quantity of the variant.",
"type": "integer",
"default": 1
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"PublishableApiKey": {
"title": "Publishable API key",
"description": "Publishable API key defines scopes (i.e. resources) that are available within a request.",
"type": "object",
"required": [
"created_at",
"created_by",
"id",
"revoked_by",
"revoked_at",
"title",
"updated_at"
],
"properties": {
"id": {
"description": "The key's ID",
"type": "string",
"example": "pk_01G1G5V27GYX4QXNARRQCW1N8T"
},
"created_by": {
"description": "The unique identifier of the user that created the key.",
"nullable": true,
"type": "string",
"example": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V"
},
"revoked_by": {
"description": "The unique identifier of the user that revoked the key.",
"nullable": true,
"type": "string",
"example": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V"
},
"revoked_at": {
"description": "The date with timezone at which the key was revoked.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"title": {
"description": "The key's title.",
"type": "string"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
}
}
},
"PublishableApiKeySalesChannel": {
"title": "Publishable API key sales channel",
"description": "Holds mapping between Publishable API keys and Sales Channels",
"type": "object",
"required": [
"publishable_key_id",
"sales_channel_id"
],
"properties": {
"sales_channel_id": {
"description": "The sales channel's ID",
"type": "string",
"example": "sc_01G1G5V21KADXNGH29BJMAJ4B4"
},
"publishable_key_id": {
"description": "The publishable API key's ID",
"type": "string",
"example": "pak_01G1G5V21KADXNGH29BJMAJ4B4"
}
}
},
"Refund": {
"title": "Refund",
"description": "Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator.",
"type": "object",
"required": [
"amount",
"created_at",
"id",
"idempotency_key",
"metadata",
"note",
"order_id",
"payment_id",
"reason",
"updated_at"
],
"properties": {
"id": {
"description": "The refund's ID",
"type": "string",
"example": "ref_01G1G5V27GYX4QXNARRQCW1N8T"
},
"order_id": {
"description": "The id of the Order that the Refund is related to.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"payment_id": {
"description": "The payment's ID if available",
"nullable": true,
"type": "string",
"example": "pay_01G8ZCC5W42ZNY842124G7P5R9"
},
"payment": {
"description": "Available if the relation `payment` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Payment"
},
"amount": {
"description": "The amount that has be refunded to the Customer.",
"type": "integer",
"example": 1000
},
"note": {
"description": "An optional note explaining why the amount was refunded.",
"nullable": true,
"type": "string",
"example": "I didn't like it"
},
"reason": {
"description": "The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.",
"type": "string",
"enum": [
"discount",
"return",
"swap",
"claim",
"other"
],
"example": "return"
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the refund in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"Region": {
"title": "Region",
"description": "Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries.",
"type": "object",
"required": [
"automatic_taxes",
"created_at",
"currency_code",
"deleted_at",
"gift_cards_taxable",
"id",
"metadata",
"name",
"tax_code",
"tax_provider_id",
"tax_rate",
"updated_at"
],
"properties": {
"id": {
"description": "The region's ID",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"name": {
"description": "The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.",
"type": "string",
"example": "EU"
},
"currency_code": {
"description": "The 3 character currency code that the Region uses.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"currency": {
"description": "Available if the relation `currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"tax_rate": {
"description": "The tax rate that should be charged on purchases in the Region.",
"type": "number",
"example": 0
},
"tax_rates": {
"description": "The tax rates that are included in the Region. Available if the relation `tax_rates` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/TaxRate"
}
},
"tax_code": {
"description": "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.",
"nullable": true,
"type": "string",
"example": null
},
"gift_cards_taxable": {
"description": "Whether the gift cards are taxable or not in this region.",
"type": "boolean",
"default": true
},
"automatic_taxes": {
"description": "Whether taxes should be automated in this region.",
"type": "boolean",
"default": true
},
"countries": {
"description": "The countries that are included in the Region. Available if the relation `countries` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Country"
}
},
"tax_provider_id": {
"description": "The ID of the tax provider used in this region",
"nullable": true,
"type": "string",
"example": null
},
"tax_provider": {
"description": "Available if the relation `tax_provider` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/TaxProvider"
},
"payment_providers": {
"description": "The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/PaymentProvider"
}
},
"fulfillment_providers": {
"description": "The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `fulfillment_providers` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentProvider"
}
},
"includes_tax": {
"description": "[EXPERIMENTAL] Does the prices for the region include tax",
"type": "boolean",
"default": false
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ReservationItemDTO": {
"title": "Reservation item",
"description": "Represents a reservation of an inventory item at a stock location",
"type": "object",
"required": [
"id",
"location_id",
"inventory_item_id",
"quantity"
],
"properties": {
"id": {
"description": "The id of the reservation item",
"type": "string"
},
"location_id": {
"description": "The id of the location of the reservation",
"type": "string"
},
"inventory_item_id": {
"description": "The id of the inventory item the reservation relates to",
"type": "string"
},
"quantity": {
"description": "The id of the reservation item",
"type": "number"
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"description": "The date with timezone at which the resource was deleted.",
"format": "date-time"
}
}
},
"Return": {
"title": "Return",
"description": "Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap.",
"type": "object",
"required": [
"claim_order_id",
"created_at",
"id",
"idempotency_key",
"location_id",
"metadata",
"no_notification",
"order_id",
"received_at",
"refund_amount",
"shipping_data",
"status",
"swap_id",
"updated_at"
],
"properties": {
"id": {
"description": "The return's ID",
"type": "string",
"example": "ret_01F0YET7XPCMF8RZ0Y151NZV2V"
},
"status": {
"description": "Status of the Return.",
"type": "string",
"enum": [
"requested",
"received",
"requires_action",
"canceled"
],
"default": "requested"
},
"items": {
"description": "The Return Items that will be shipped back to the warehouse. Available if the relation `items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnItem"
}
},
"swap_id": {
"description": "The ID of the Swap that the Return is a part of.",
"nullable": true,
"type": "string",
"example": null
},
"swap": {
"description": "A swap object. Available if the relation `swap` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Swap"
},
"claim_order_id": {
"description": "The ID of the Claim that the Return is a part of.",
"nullable": true,
"type": "string",
"example": null
},
"claim_order": {
"description": "A claim order object. Available if the relation `claim_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimOrder"
},
"order_id": {
"description": "The ID of the Order that the Return is made from.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"shipping_method": {
"description": "The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingMethod"
},
"shipping_data": {
"description": "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.",
"nullable": true,
"type": "object",
"example": {}
},
"location_id": {
"description": "The id of the stock location the return will be added back.",
"nullable": true,
"type": "string",
"example": "sloc_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"refund_amount": {
"description": "The amount that should be refunded as a result of the return.",
"type": "integer",
"example": 1000
},
"no_notification": {
"description": "When set to true, no notification will be sent related to this return.",
"nullable": true,
"type": "boolean",
"example": false
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the return in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"received_at": {
"description": "The date with timezone at which the return was received.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ReturnItem": {
"title": "Return Item",
"description": "Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned.",
"type": "object",
"required": [
"is_requested",
"item_id",
"metadata",
"note",
"quantity",
"reason_id",
"received_quantity",
"requested_quantity",
"return_id"
],
"properties": {
"return_id": {
"description": "The id of the Return that the Return Item belongs to.",
"type": "string",
"example": "ret_01F0YET7XPCMF8RZ0Y151NZV2V"
},
"item_id": {
"description": "The id of the Line Item that the Return Item references.",
"type": "string",
"example": "item_01G8ZC9GWT6B2GP5FSXRXNFNGN"
},
"return_order": {
"description": "Available if the relation `return_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Return"
},
"item": {
"description": "Available if the relation `item` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/LineItem"
},
"quantity": {
"description": "The quantity of the Line Item that is included in the Return.",
"type": "integer",
"example": 1
},
"is_requested": {
"description": "Whether the Return Item was requested initially or received unexpectedly in the warehouse.",
"type": "boolean",
"default": true
},
"requested_quantity": {
"description": "The quantity that was originally requested to be returned.",
"nullable": true,
"type": "integer",
"example": 1
},
"received_quantity": {
"description": "The quantity that was received in the warehouse.",
"nullable": true,
"type": "integer",
"example": 1
},
"reason_id": {
"description": "The ID of the reason for returning the item.",
"nullable": true,
"type": "string",
"example": "rr_01G8X82GCCV2KSQHDBHSSAH5TQ"
},
"reason": {
"description": "Available if the relation `reason` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ReturnReason"
},
"note": {
"description": "An optional note with additional details about the Return.",
"nullable": true,
"type": "string",
"example": "I didn't like it."
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ReturnReason": {
"title": "Return Reason",
"description": "A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"description",
"id",
"label",
"metadata",
"parent_return_reason_id",
"updated_at",
"value"
],
"properties": {
"id": {
"description": "The return reason's ID",
"type": "string",
"example": "rr_01G8X82GCCV2KSQHDBHSSAH5TQ"
},
"value": {
"description": "The value to identify the reason by.",
"type": "string",
"example": "damaged"
},
"label": {
"description": "A text that can be displayed to the Customer as a reason.",
"type": "string",
"example": "Damaged goods"
},
"description": {
"description": "A description of the Reason.",
"nullable": true,
"type": "string",
"example": "Items that are damaged"
},
"parent_return_reason_id": {
"description": "The ID of the parent reason.",
"nullable": true,
"type": "string",
"example": null
},
"parent_return_reason": {
"description": "Available if the relation `parent_return_reason` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ReturnReason"
},
"return_reason_children": {
"description": "Available if the relation `return_reason_children` is expanded.",
"$ref": "#/components/schemas/ReturnReason"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"SalesChannel": {
"title": "Sales Channel",
"description": "A Sales Channel",
"type": "object",
"required": [
"created_at",
"deleted_at",
"description",
"id",
"is_disabled",
"name",
"updated_at"
],
"properties": {
"id": {
"description": "The sales channel's ID",
"type": "string",
"example": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"name": {
"description": "The name of the sales channel.",
"type": "string",
"example": "Market"
},
"description": {
"description": "The description of the sales channel.",
"nullable": true,
"type": "string",
"example": "Multi-vendor market"
},
"is_disabled": {
"description": "Specify if the sales channel is enabled or disabled.",
"type": "boolean",
"default": false
},
"locations": {
"description": "The Stock Locations related to the sales channel. Available if the relation `locations` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/SalesChannelLocation"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"SalesChannelLocation": {
"title": "Sales Channel Stock Location",
"description": "Sales Channel Stock Location link sales channels with stock locations.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"location_id",
"sales_channel_id",
"updated_at"
],
"properties": {
"id": {
"description": "The Sales Channel Stock Location's ID",
"type": "string",
"example": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"sales_channel_id": {
"description": "The id of the Sales Channel",
"type": "string",
"example": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A"
},
"location_id": {
"description": "The id of the Location Stock.",
"type": "string"
},
"sales_channel": {
"description": "The sales channel the location is associated with. Available if the relation `sales_channel` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/SalesChannel"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"ShippingMethod": {
"title": "Shipping Method",
"description": "Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment.",
"type": "object",
"required": [
"cart_id",
"claim_order_id",
"data",
"id",
"order_id",
"price",
"return_id",
"shipping_option_id",
"swap_id"
],
"properties": {
"id": {
"description": "The shipping method's ID",
"type": "string",
"example": "sm_01F0YET7DR2E7CYVSDHM593QG2"
},
"shipping_option_id": {
"description": "The id of the Shipping Option that the Shipping Method is built from.",
"type": "string",
"example": "so_01G1G5V27GYX4QXNARRQCW1N8T"
},
"order_id": {
"description": "The id of the Order that the Shipping Method is used on.",
"nullable": true,
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"claim_order_id": {
"description": "The id of the Claim that the Shipping Method is used on.",
"nullable": true,
"type": "string",
"example": null
},
"claim_order": {
"description": "A claim order object. Available if the relation `claim_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ClaimOrder"
},
"cart_id": {
"description": "The id of the Cart that the Shipping Method is used on.",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"swap_id": {
"description": "The id of the Swap that the Shipping Method is used on.",
"nullable": true,
"type": "string",
"example": null
},
"swap": {
"description": "A swap object. Available if the relation `swap` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Swap"
},
"return_id": {
"description": "The id of the Return that the Shipping Method is used on.",
"nullable": true,
"type": "string",
"example": null
},
"return_order": {
"description": "A return object. Available if the relation `return_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Return"
},
"shipping_option": {
"description": "Available if the relation `shipping_option` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingOption"
},
"tax_lines": {
"description": "Available if the relation `tax_lines` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMethodTaxLine"
}
},
"price": {
"description": "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.",
"type": "integer",
"example": 200
},
"data": {
"description": "Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.",
"type": "object",
"example": {}
},
"includes_tax": {
"description": "[EXPERIMENTAL] Indicates if the shipping method price include tax",
"type": "boolean",
"default": false
},
"subtotal": {
"description": "The subtotal of the shipping",
"type": "integer",
"example": 8000
},
"total": {
"description": "The total amount of the shipping",
"type": "integer",
"example": 8200
},
"tax_total": {
"description": "The total of tax",
"type": "integer",
"example": 0
}
}
},
"ShippingMethodTaxLine": {
"title": "Shipping Method Tax Line",
"description": "Shipping Method Tax Line",
"type": "object",
"required": [
"code",
"created_at",
"id",
"shipping_method_id",
"metadata",
"name",
"rate",
"updated_at"
],
"properties": {
"id": {
"description": "The line item tax line's ID",
"type": "string",
"example": "smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8"
},
"code": {
"description": "A code to identify the tax type by",
"nullable": true,
"type": "string",
"example": "tax01"
},
"name": {
"description": "A human friendly name for the tax",
"type": "string",
"example": "Tax Example"
},
"rate": {
"description": "The numeric rate to charge tax by",
"type": "number",
"example": 10
},
"shipping_method_id": {
"description": "The ID of the line item",
"type": "string",
"example": "sm_01F0YET7DR2E7CYVSDHM593QG2"
},
"shipping_method": {
"description": "Available if the relation `shipping_method` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingMethod"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ShippingOption": {
"title": "Shipping Option",
"description": "Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.",
"type": "object",
"required": [
"admin_only",
"amount",
"created_at",
"data",
"deleted_at",
"id",
"is_return",
"metadata",
"name",
"price_type",
"profile_id",
"provider_id",
"region_id",
"updated_at"
],
"properties": {
"id": {
"description": "The shipping option's ID",
"type": "string",
"example": "so_01G1G5V27GYX4QXNARRQCW1N8T"
},
"name": {
"description": "The name given to the Shipping Option - this may be displayed to the Customer.",
"type": "string",
"example": "PostFake Standard"
},
"region_id": {
"description": "The region's ID",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"profile_id": {
"description": "The ID of the Shipping Profile that the shipping option belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products.",
"type": "string",
"example": "sp_01G1G5V239ENSZ5MV4JAR737BM"
},
"profile": {
"description": "Available if the relation `profile` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingProfile"
},
"provider_id": {
"description": "The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option.",
"type": "string",
"example": "manual"
},
"provider": {
"description": "Available if the relation `provider` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/FulfillmentProvider"
},
"price_type": {
"description": "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.",
"type": "string",
"enum": [
"flat_rate",
"calculated"
],
"example": "flat_rate"
},
"amount": {
"description": "The amount to charge for shipping when the Shipping Option price type is `flat_rate`.",
"nullable": true,
"type": "integer",
"example": 200
},
"is_return": {
"description": "Flag to indicate if the Shipping Option can be used for Return shipments.",
"type": "boolean",
"default": false
},
"admin_only": {
"description": "Flag to indicate if the Shipping Option usage is restricted to admin users.",
"type": "boolean",
"default": false
},
"requirements": {
"description": "The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingOptionRequirement"
}
},
"data": {
"description": "The data needed for the Fulfillment Provider to identify the Shipping Option.",
"type": "object",
"example": {}
},
"includes_tax": {
"description": "[EXPERIMENTAL] Does the shipping option price include tax",
"type": "boolean",
"default": false
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ShippingOptionRequirement": {
"title": "Shipping Option Requirement",
"description": "A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart.",
"type": "object",
"required": [
"amount",
"deleted_at",
"id",
"shipping_option_id",
"type"
],
"properties": {
"id": {
"description": "The shipping option requirement's ID",
"type": "string",
"example": "sor_01G1G5V29AB4CTNDRFSRWSRKWD"
},
"shipping_option_id": {
"description": "The id of the Shipping Option that the hipping option requirement belongs to",
"type": "string",
"example": "so_01G1G5V27GYX4QXNARRQCW1N8T"
},
"shipping_option": {
"description": "Available if the relation `shipping_option` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingOption"
},
"type": {
"description": "The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available.",
"type": "string",
"enum": [
"min_subtotal",
"max_subtotal"
],
"example": "min_subtotal"
},
"amount": {
"description": "The amount to compare the Cart subtotal to.",
"type": "integer",
"example": 100
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
}
}
},
"ShippingProfile": {
"title": "Shipping Profile",
"description": "Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"id",
"metadata",
"name",
"type",
"updated_at"
],
"properties": {
"id": {
"description": "The shipping profile's ID",
"type": "string",
"example": "sp_01G1G5V239ENSZ5MV4JAR737BM"
},
"name": {
"description": "The name given to the Shipping profile - this may be displayed to the Customer.",
"type": "string",
"example": "Default Shipping Profile"
},
"type": {
"description": "The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.",
"type": "string",
"enum": [
"default",
"gift_card",
"custom"
],
"example": "default"
},
"products": {
"description": "The Products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"shipping_options": {
"description": "The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingOption"
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"ShippingTaxRate": {
"title": "Shipping Tax Rate",
"description": "Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way",
"type": "object",
"required": [
"created_at",
"metadata",
"rate_id",
"shipping_option_id",
"updated_at"
],
"properties": {
"shipping_option_id": {
"description": "The ID of the Shipping Option",
"type": "string",
"example": "so_01G1G5V27GYX4QXNARRQCW1N8T"
},
"shipping_option": {
"description": "Available if the relation `shipping_option` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/ShippingOption"
},
"rate_id": {
"description": "The ID of the Tax Rate",
"type": "string",
"example": "txr_01G8XDBAWKBHHJRKH0AV02KXBR"
},
"tax_rate": {
"description": "Available if the relation `tax_rate` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/TaxRate"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"StagedJob": {
"title": "Staged Job",
"description": "A staged job resource",
"type": "object",
"required": [
"data",
"event_name",
"id",
"options"
],
"properties": {
"id": {
"description": "The staged job's ID",
"type": "string",
"example": "job_01F0YET7BZTARY9MKN1SJ7AAXF"
},
"event_name": {
"description": "The name of the event",
"type": "string",
"example": "order.placed"
},
"data": {
"description": "Data necessary for the job",
"type": "object",
"example": {}
},
"option": {
"description": "The staged job's option",
"type": "object",
"example": {}
}
}
},
"StockLocationAddressDTO": {
"title": "Stock Location Address",
"description": "Represents a Stock Location Address",
"type": "object",
"required": [
"address_1",
"country_code",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"description": "The stock location address' ID",
"example": "laddr_51G4ZW853Y6TFXWPG5ENJ81X42"
},
"address_1": {
"type": "string",
"description": "Stock location address",
"example": "35, Jhon Doe Ave"
},
"address_2": {
"type": "string",
"description": "Stock location address' complement",
"example": "apartment 4432"
},
"company": {
"type": "string",
"description": "Stock location company' name",
"example": "Medusa"
},
"city": {
"type": "string",
"description": "Stock location address' city",
"example": "Mexico city"
},
"country_code": {
"type": "string",
"description": "Stock location address' country",
"example": "MX"
},
"phone": {
"type": "string",
"description": "Stock location address' phone number",
"example": "+1 555 61646"
},
"postal_code": {
"type": "string",
"description": "Stock location address' postal code",
"example": "HD3-1G8"
},
"province": {
"type": "string",
"description": "Stock location address' province",
"example": "Sinaloa"
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"description": "The date with timezone at which the resource was deleted.",
"format": "date-time"
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
}
}
},
"StockLocationAddressInput": {
"title": "Stock Location Address Input",
"description": "Represents a Stock Location Address Input",
"type": "object",
"required": [
"address_1",
"country_code"
],
"properties": {
"address_1": {
"type": "string",
"description": "Stock location address",
"example": "35, Jhon Doe Ave"
},
"address_2": {
"type": "string",
"description": "Stock location address' complement",
"example": "apartment 4432"
},
"city": {
"type": "string",
"description": "Stock location address' city",
"example": "Mexico city"
},
"country_code": {
"type": "string",
"description": "Stock location address' country",
"example": "MX"
},
"phone": {
"type": "string",
"description": "Stock location address' phone number",
"example": "+1 555 61646"
},
"postal_code": {
"type": "string",
"description": "Stock location address' postal code",
"example": "HD3-1G8"
},
"province": {
"type": "string",
"description": "Stock location address' province",
"example": "Sinaloa"
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
}
}
},
"StockLocationDTO": {
"title": "Stock Location",
"description": "Represents a Stock Location",
"type": "object",
"required": [
"id",
"name",
"address_id",
"created_at",
"updated_at"
],
"properties": {
"id": {
"type": "string",
"description": "The stock location's ID",
"example": "sloc_51G4ZW853Y6TFXWPG5ENJ81X42"
},
"address_id": {
"type": "string",
"description": "Stock location address' ID",
"example": "laddr_05B2ZE853Y6FTXWPW85NJ81A44"
},
"name": {
"type": "string",
"description": "The name of the stock location",
"example": "Main Warehouse"
},
"address": {
"description": "The Address of the Stock Location",
"allOf": [
{
"$ref": "#/components/schemas/StockLocationAddressDTO"
},
{
"type": "object"
}
]
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
},
"created_at": {
"type": "string",
"description": "The date with timezone at which the resource was created.",
"format": "date-time"
},
"updated_at": {
"type": "string",
"description": "The date with timezone at which the resource was updated.",
"format": "date-time"
},
"deleted_at": {
"type": "string",
"description": "The date with timezone at which the resource was deleted.",
"format": "date-time"
}
}
},
"StockLocationExpandedDTO": {
"allOf": [
{
"$ref": "#/components/schemas/StockLocationDTO"
},
{
"type": "object",
"properties": {
"sales_channels": {
"$ref": "#/components/schemas/SalesChannel"
}
}
}
]
},
"Store": {
"title": "Store",
"description": "Holds settings for the Store, such as name, currencies, etc.",
"type": "object",
"required": [
"created_at",
"default_currency_code",
"default_location_id",
"id",
"invite_link_template",
"metadata",
"name",
"payment_link_template",
"swap_link_template",
"updated_at"
],
"properties": {
"id": {
"description": "The store's ID",
"type": "string",
"example": "store_01G1G5V21KADXNGH29BJMAJ4B4"
},
"name": {
"description": "The name of the Store - this may be displayed to the Customer.",
"type": "string",
"example": "Medusa Store"
},
"default_currency_code": {
"description": "The 3 character currency code that is the default of the store.",
"type": "string",
"example": "usd",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_4217#Active_codes",
"description": "See a list of codes."
}
},
"default_currency": {
"description": "Available if the relation `default_currency` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Currency"
},
"currencies": {
"description": "The currencies that are enabled for the Store. Available if the relation `currencies` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Currency"
}
},
"swap_link_template": {
"description": "A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link.",
"nullable": true,
"type": "string",
"example": null
},
"payment_link_template": {
"description": "A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link.",
"nullable": true,
"type": "string",
"example": null
},
"invite_link_template": {
"description": "A template to generate Invite links from",
"nullable": true,
"type": "string",
"example": null
},
"default_location_id": {
"description": "The location ID the store is associated with.",
"nullable": true,
"type": "string",
"example": null
},
"default_sales_channel_id": {
"description": "The sales channel ID the cart is associated with.",
"nullable": true,
"type": "string",
"example": null
},
"default_sales_channel": {
"description": "A sales channel object. Available if the relation `default_sales_channel` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/SalesChannel"
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"StoreAuthRes": {
"type": "object",
"x-expanded-relations": {
"field": "customer",
"relations": [
"orders",
"orders.items",
"shipping_addresses"
]
},
"required": [
"customer"
],
"properties": {
"customer": {
"$ref": "#/components/schemas/Customer"
}
}
},
"StoreCartShippingOptionsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "shipping_options",
"implicit": [
"profile",
"requirements"
]
},
"required": [
"shipping_options"
],
"properties": {
"shipping_options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricedShippingOption"
}
}
}
},
"StoreCartsRes": {
"type": "object",
"x-expanded-relations": {
"field": "cart",
"relations": [
"billing_address",
"discounts",
"discounts.rule",
"gift_cards",
"items",
"items.adjustments",
"items.variant",
"payment",
"payment_sessions",
"region",
"region.countries",
"region.payment_providers",
"shipping_address",
"shipping_methods"
],
"eager": [
"region.fulfillment_providers",
"region.payment_providers",
"shipping_methods.shipping_option"
],
"implicit": [
"items",
"items.variant",
"items.variant.product",
"items.tax_lines",
"items.adjustments",
"gift_cards",
"discounts",
"discounts.rule",
"shipping_methods",
"shipping_methods.tax_lines",
"shipping_address",
"region",
"region.tax_rates"
],
"totals": [
"discount_total",
"gift_card_tax_total",
"gift_card_total",
"item_tax_total",
"refundable_amount",
"refunded_total",
"shipping_tax_total",
"shipping_total",
"subtotal",
"tax_total",
"total",
"items.discount_total",
"items.gift_card_total",
"items.original_tax_total",
"items.original_total",
"items.refundable",
"items.subtotal",
"items.tax_total",
"items.total"
]
},
"required": [
"cart"
],
"properties": {
"cart": {
"$ref": "#/components/schemas/Cart"
}
}
},
"StoreCollectionsListRes": {
"type": "object",
"required": [
"collections",
"count",
"offset",
"limit"
],
"properties": {
"collections": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCollection"
}
},
"count": {
"type": "integer",
"description": "The total number of items available"
},
"offset": {
"type": "integer",
"description": "The number of items skipped before these items"
},
"limit": {
"type": "integer",
"description": "The number of items per page"
}
}
},
"StoreCollectionsRes": {
"type": "object",
"required": [
"collection"
],
"properties": {
"collection": {
"$ref": "#/components/schemas/ProductCollection"
}
}
},
"StoreCompleteCartRes": {
"type": "object",
"required": [
"type",
"data"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the data property.",
"enum": [
"order",
"cart",
"swap"
]
},
"data": {
"type": "object",
"description": "The data of the result object. Its type depends on the type field.",
"oneOf": [
{
"type": "object",
"allOf": [
{
"description": "Cart was successfully authorized and order was placed successfully."
},
{
"$ref": "#/components/schemas/Order"
}
]
},
{
"type": "object",
"allOf": [
{
"description": "Cart was successfully authorized but requires further actions."
},
{
"$ref": "#/components/schemas/Cart"
}
]
},
{
"type": "object",
"allOf": [
{
"description": "When cart is used for a swap and it has been completed successfully."
},
{
"$ref": "#/components/schemas/Swap"
}
]
}
]
}
}
},
"StoreCustomersListOrdersRes": {
"type": "object",
"x-expanded-relations": {
"field": "orders",
"relations": [
"customer",
"discounts",
"discounts.rule",
"fulfillments",
"fulfillments.tracking_links",
"items",
"items.variant",
"payments",
"region",
"shipping_address",
"shipping_methods"
],
"eager": [
"region.fulfillment_providers",
"region.payment_providers",
"shipping_methods.shipping_option"
],
"implicit": [
"claims",
"claims.additional_items",
"claims.additional_items.adjustments",
"claims.additional_items.refundable",
"claims.additional_items.tax_lines",
"customer",
"discounts",
"discounts.rule",
"gift_card_transactions",
"gift_card_transactions.gift_card",
"gift_cards",
"items",
"items.adjustments",
"items.refundable",
"items.tax_lines",
"items.variant",
"items.variant.product",
"refunds",
"region",
"shipping_address",
"shipping_methods",
"shipping_methods.tax_lines",
"swaps",
"swaps.additional_items",
"swaps.additional_items.adjustments",
"swaps.additional_items.refundable",
"swaps.additional_items.tax_lines"
],
"totals": [
"discount_total",
"gift_card_tax_total",
"gift_card_total",
"paid_total",
"refundable_amount",
"refunded_total",
"shipping_total",
"subtotal",
"tax_total",
"total",
"claims.additional_items.discount_total",
"claims.additional_items.gift_card_total",
"claims.additional_items.original_tax_total",
"claims.additional_items.original_total",
"claims.additional_items.refundable",
"claims.additional_items.subtotal",
"claims.additional_items.tax_total",
"claims.additional_items.total",
"items.discount_total",
"items.gift_card_total",
"items.original_tax_total",
"items.original_total",
"items.refundable",
"items.subtotal",
"items.tax_total",
"items.total",
"swaps.additional_items.discount_total",
"swaps.additional_items.gift_card_total",
"swaps.additional_items.original_tax_total",
"swaps.additional_items.original_total",
"swaps.additional_items.refundable",
"swaps.additional_items.subtotal",
"swaps.additional_items.tax_total",
"swaps.additional_items.total"
]
},
"required": [
"orders",
"count",
"offset",
"limit"
],
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Order"
}
},
"count": {
"description": "The total number of items available",
"type": "integer"
},
"offset": {
"description": "The number of items skipped before these items",
"type": "integer"
},
"limit": {
"description": "The number of items per page",
"type": "integer"
}
}
},
"StoreCustomersListPaymentMethodsRes": {
"type": "object",
"required": [
"payment_methods"
],
"properties": {
"payment_methods": {
"type": "array",
"items": {
"type": "object",
"required": [
"provider_id",
"data"
],
"properties": {
"provider_id": {
"description": "The id of the Payment Provider where the payment method is saved.",
"type": "string"
},
"data": {
"description": "The data needed for the Payment Provider to use the saved payment method.",
"type": "object"
}
}
}
}
}
},
"StoreCustomersRes": {
"type": "object",
"x-expanded-relations": {
"field": "customer",
"relations": [
"billing_address",
"shipping_addresses"
]
},
"required": [
"customer"
],
"properties": {
"customer": {
"$ref": "#/components/schemas/Customer"
}
}
},
"StoreCustomersResetPasswordRes": {
"type": "object",
"required": [
"customer"
],
"properties": {
"customer": {
"$ref": "#/components/schemas/Customer"
}
}
},
"StoreGetAuthEmailRes": {
"type": "object",
"required": [
"exists"
],
"properties": {
"exists": {
"description": "Whether email exists or not.",
"type": "boolean"
}
}
},
"StoreGetProductCategoriesCategoryRes": {
"type": "object",
"x-expanded-relations": {
"field": "product_category",
"relations": [
"category_children",
"parent_category"
]
},
"required": [
"product_category"
],
"properties": {
"product_category": {
"$ref": "#/components/schemas/ProductCategory"
}
}
},
"StoreGetProductCategoriesRes": {
"type": "object",
"x-expanded-relations": {
"field": "product_categories",
"relations": [
"category_children",
"parent_category"
]
},
"required": [
"product_categories",
"count",
"offset",
"limit"
],
"properties": {
"product_categories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductCategory"
}
},
"count": {
"type": "integer",
"description": "The total number of items available"
},
"offset": {
"type": "integer",
"description": "The number of items skipped before these items"
},
"limit": {
"type": "integer",
"description": "The number of items per page"
}
}
},
"StoreGiftCardsRes": {
"type": "object",
"required": [
"gift_card"
],
"properties": {
"gift_card": {
"$ref": "#/components/schemas/GiftCard"
}
}
},
"StoreOrderEditsRes": {
"type": "object",
"x-expanded-relations": {
"field": "order_edit",
"relations": [
"changes",
"changes.line_item",
"changes.line_item.variant",
"changes.original_line_item",
"changes.original_line_item.variant",
"items",
"items.adjustments",
"items.tax_lines",
"items.variant",
"payment_collection"
],
"implicit": [
"items",
"items.tax_lines",
"items.adjustments",
"items.variant"
],
"totals": [
"difference_due",
"discount_total",
"gift_card_tax_total",
"gift_card_total",
"shipping_total",
"subtotal",
"tax_total",
"total",
"items.discount_total",
"items.gift_card_total",
"items.original_tax_total",
"items.original_total",
"items.refundable",
"items.subtotal",
"items.tax_total",
"items.total"
]
},
"required": [
"order_edit"
],
"properties": {
"order_edit": {
"$ref": "#/components/schemas/OrderEdit"
}
}
},
"StoreOrdersRes": {
"type": "object",
"required": [
"order"
],
"x-expanded-relations": {
"field": "order",
"relations": [
"customer",
"discounts",
"discounts.rule",
"fulfillments",
"fulfillments.tracking_links",
"items",
"items.variant",
"payments",
"region",
"shipping_address",
"shipping_methods"
],
"eager": [
"fulfillments.items",
"region.fulfillment_providers",
"region.payment_providers",
"shipping_methods.shipping_option"
],
"implicit": [
"claims",
"claims.additional_items",
"claims.additional_items.adjustments",
"claims.additional_items.refundable",
"claims.additional_items.tax_lines",
"discounts",
"discounts.rule",
"gift_card_transactions",
"gift_card_transactions.gift_card",
"gift_cards",
"items",
"items.adjustments",
"items.refundable",
"items.tax_lines",
"items.variant",
"items.variant.product",
"refunds",
"region",
"shipping_methods",
"shipping_methods.tax_lines",
"swaps",
"swaps.additional_items",
"swaps.additional_items.adjustments",
"swaps.additional_items.refundable",
"swaps.additional_items.tax_lines"
],
"totals": [
"discount_total",
"gift_card_tax_total",
"gift_card_total",
"paid_total",
"refundable_amount",
"refunded_total",
"shipping_total",
"subtotal",
"tax_total",
"total",
"claims.additional_items.discount_total",
"claims.additional_items.gift_card_total",
"claims.additional_items.original_tax_total",
"claims.additional_items.original_total",
"claims.additional_items.refundable",
"claims.additional_items.subtotal",
"claims.additional_items.tax_total",
"claims.additional_items.total",
"items.discount_total",
"items.gift_card_total",
"items.original_tax_total",
"items.original_total",
"items.refundable",
"items.subtotal",
"items.tax_total",
"items.total",
"swaps.additional_items.discount_total",
"swaps.additional_items.gift_card_total",
"swaps.additional_items.original_tax_total",
"swaps.additional_items.original_total",
"swaps.additional_items.refundable",
"swaps.additional_items.subtotal",
"swaps.additional_items.tax_total",
"swaps.additional_items.total"
]
},
"properties": {
"order": {
"$ref": "#/components/schemas/Order"
}
}
},
"StorePaymentCollectionSessionsReq": {
"type": "object",
"required": [
"provider_id"
],
"properties": {
"provider_id": {
"type": "string",
"description": "The ID of the Payment Provider."
}
}
},
"StorePaymentCollectionsRes": {
"type": "object",
"x-expanded-relations": {
"field": "payment_collection",
"relations": [
"payment_sessions",
"region"
],
"eager": [
"region.fulfillment_providers",
"region.payment_providers"
]
},
"required": [
"payment_collection"
],
"properties": {
"payment_collection": {
"$ref": "#/components/schemas/PaymentCollection"
}
}
},
"StorePaymentCollectionsSessionRes": {
"type": "object",
"required": [
"payment_session"
],
"properties": {
"payment_session": {
"$ref": "#/components/schemas/PaymentSession"
}
}
},
"StorePostAuthReq": {
"type": "object",
"required": [
"email",
"password"
],
"properties": {
"email": {
"type": "string",
"description": "The Customer's email."
},
"password": {
"type": "string",
"description": "The Customer's password."
}
}
},
"StorePostCartReq": {
"type": "object",
"properties": {
"region_id": {
"type": "string",
"description": "The ID of the Region to create the Cart in."
},
"sales_channel_id": {
"type": "string",
"description": "[EXPERIMENTAL] The ID of the Sales channel to create the Cart in."
},
"country_code": {
"type": "string",
"description": "The 2 character ISO country code to create the Cart in.",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
}
},
"items": {
"description": "An optional array of `variant_id`, `quantity` pairs to generate Line Items from.",
"type": "array",
"items": {
"type": "object",
"required": [
"variant_id",
"quantity"
],
"properties": {
"variant_id": {
"description": "The id of the Product Variant to generate a Line Item from.",
"type": "string"
},
"quantity": {
"description": "The quantity of the Product Variant to add",
"type": "integer"
}
}
}
},
"context": {
"description": "An optional object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`",
"type": "object",
"example": {
"ip": "::1",
"user_agent": "Chrome"
}
}
}
},
"StorePostCartsCartLineItemsItemReq": {
"type": "object",
"required": [
"quantity"
],
"properties": {
"quantity": {
"type": "number",
"description": "The quantity to set the Line Item to."
}
}
},
"StorePostCartsCartLineItemsReq": {
"type": "object",
"required": [
"variant_id",
"quantity"
],
"properties": {
"variant_id": {
"type": "string",
"description": "The id of the Product Variant to generate the Line Item from."
},
"quantity": {
"type": "number",
"description": "The quantity of the Product Variant to add to the Line Item."
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details about the Line Item."
}
}
},
"StorePostCartsCartPaymentSessionReq": {
"type": "object",
"required": [
"provider_id"
],
"properties": {
"provider_id": {
"type": "string",
"description": "The ID of the Payment Provider."
}
}
},
"StorePostCartsCartPaymentSessionUpdateReq": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"description": "The data to update the payment session with."
}
}
},
"StorePostCartsCartReq": {
"type": "object",
"properties": {
"region_id": {
"type": "string",
"description": "The id of the Region to create the Cart in."
},
"country_code": {
"type": "string",
"description": "The 2 character ISO country code to create the Cart in.",
"externalDocs": {
"url": "https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements",
"description": "See a list of codes."
}
},
"email": {
"type": "string",
"description": "An email to be used on the Cart.",
"format": "email"
},
"sales_channel_id": {
"type": "string",
"description": "The ID of the Sales channel to update the Cart with."
},
"billing_address": {
"description": "The Address to be used for billing purposes.",
"anyOf": [
{
"$ref": "#/components/schemas/AddressPayload",
"description": "A full billing address object."
},
{
"type": "string",
"description": "The billing address ID"
}
]
},
"shipping_address": {
"description": "The Address to be used for shipping.",
"anyOf": [
{
"$ref": "#/components/schemas/AddressPayload",
"description": "A full shipping address object."
},
{
"type": "string",
"description": "The shipping address ID"
}
]
},
"gift_cards": {
"description": "An array of Gift Card codes to add to the Cart.",
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "The code that a Gift Card is identified by.",
"type": "string"
}
}
}
},
"discounts": {
"description": "An array of Discount codes to add to the Cart.",
"type": "array",
"items": {
"type": "object",
"required": [
"code"
],
"properties": {
"code": {
"description": "The code that a Discount is identified by.",
"type": "string"
}
}
}
},
"customer_id": {
"description": "The ID of the Customer to associate the Cart with.",
"type": "string"
},
"context": {
"description": "An optional object to provide context to the Cart.",
"type": "object",
"example": {
"ip": "::1",
"user_agent": "Chrome"
}
}
}
},
"StorePostCartsCartShippingMethodReq": {
"type": "object",
"required": [
"option_id"
],
"properties": {
"option_id": {
"type": "string",
"description": "ID of the shipping option to create the method from"
},
"data": {
"type": "object",
"description": "Used to hold any data that the shipping method may need to process the fulfillment of the order. Look at the documentation for your installed fulfillment providers to find out what to send."
}
}
},
"StorePostCustomersCustomerAcceptClaimReq": {
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"description": "The invite token provided by the admin.",
"type": "string"
}
}
},
"StorePostCustomersCustomerAddressesAddressReq": {
"anyOf": [
{
"$ref": "#/components/schemas/AddressPayload"
}
]
},
"StorePostCustomersCustomerAddressesReq": {
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"description": "The Address to add to the Customer.",
"$ref": "#/components/schemas/AddressCreatePayload"
}
}
},
"StorePostCustomersCustomerOrderClaimReq": {
"type": "object",
"required": [
"order_ids"
],
"properties": {
"order_ids": {
"description": "The ids of the orders to claim",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"StorePostCustomersCustomerPasswordTokenReq": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"description": "The email of the customer.",
"type": "string",
"format": "email"
}
}
},
"StorePostCustomersCustomerReq": {
"type": "object",
"properties": {
"first_name": {
"description": "The Customer's first name.",
"type": "string"
},
"last_name": {
"description": "The Customer's last name.",
"type": "string"
},
"billing_address": {
"description": "The Address to be used for billing purposes.",
"anyOf": [
{
"$ref": "#/components/schemas/AddressPayload",
"description": "The full billing address object"
},
{
"type": "string",
"description": "The ID of an existing billing address"
}
]
},
"password": {
"description": "The Customer's password.",
"type": "string"
},
"phone": {
"description": "The Customer's phone number.",
"type": "string"
},
"email": {
"description": "The email of the customer.",
"type": "string"
},
"metadata": {
"description": "Metadata about the customer.",
"type": "object"
}
}
},
"StorePostCustomersReq": {
"type": "object",
"required": [
"first_name",
"last_name",
"email",
"password"
],
"properties": {
"first_name": {
"description": "The Customer's first name.",
"type": "string"
},
"last_name": {
"description": "The Customer's last name.",
"type": "string"
},
"email": {
"description": "The email of the customer.",
"type": "string",
"format": "email"
},
"password": {
"description": "The Customer's password.",
"type": "string",
"format": "password"
},
"phone": {
"description": "The Customer's phone number.",
"type": "string"
}
}
},
"StorePostCustomersResetPasswordReq": {
"type": "object",
"required": [
"email",
"password",
"token"
],
"properties": {
"email": {
"description": "The email of the customer.",
"type": "string",
"format": "email"
},
"password": {
"description": "The Customer's password.",
"type": "string",
"format": "password"
},
"token": {
"description": "The reset password token",
"type": "string"
}
}
},
"StorePostOrderEditsOrderEditDecline": {
"type": "object",
"properties": {
"declined_reason": {
"type": "string",
"description": "The reason for declining the OrderEdit."
}
}
},
"StorePostPaymentCollectionsBatchSessionsAuthorizeReq": {
"type": "object",
"required": [
"session_ids"
],
"properties": {
"session_ids": {
"description": "List of Payment Session IDs to authorize.",
"type": "array",
"items": {
"type": "string"
}
}
}
},
"StorePostPaymentCollectionsBatchSessionsReq": {
"type": "object",
"required": [
"sessions"
],
"properties": {
"sessions": {
"description": "An array of payment sessions related to the Payment Collection. If the session_id is not provided, existing sessions not present will be deleted and the provided ones will be created.",
"type": "array",
"items": {
"type": "object",
"required": [
"provider_id",
"amount"
],
"properties": {
"provider_id": {
"type": "string",
"description": "The ID of the Payment Provider."
},
"amount": {
"type": "integer",
"description": "The amount ."
},
"session_id": {
"type": "string",
"description": "The ID of the Payment Session to be updated."
}
}
}
}
}
},
"StorePostReturnsReq": {
"type": "object",
"required": [
"order_id",
"items"
],
"properties": {
"order_id": {
"type": "string",
"description": "The ID of the Order to create the Return from."
},
"items": {
"description": "The items to include in the Return.",
"type": "array",
"items": {
"type": "object",
"required": [
"item_id",
"quantity"
],
"properties": {
"item_id": {
"description": "The ID of the Line Item from the Order.",
"type": "string"
},
"quantity": {
"description": "The quantity to return.",
"type": "integer"
},
"reason_id": {
"description": "The ID of the return reason.",
"type": "string"
},
"note": {
"description": "A note to add to the item returned.",
"type": "string"
}
}
}
},
"return_shipping": {
"description": "If the Return is to be handled by the store operator the Customer can choose a Return Shipping Method. Alternatvely the Customer can handle the Return themselves.",
"type": "object",
"required": [
"option_id"
],
"properties": {
"option_id": {
"type": "string",
"description": "The ID of the Shipping Option to create the Shipping Method from."
}
}
}
}
},
"StorePostSearchRes": {
"allOf": [
{
"type": "object",
"required": [
"hits"
],
"properties": {
"hits": {
"description": "Array of results. The format of the items depends on the search engine installed on the server.",
"type": "array"
}
}
},
{
"type": "object"
}
]
},
"StorePostSwapsReq": {
"type": "object",
"required": [
"order_id",
"return_items",
"additional_items"
],
"properties": {
"order_id": {
"type": "string",
"description": "The ID of the Order to create the Swap for."
},
"return_items": {
"description": "The items to include in the Return.",
"type": "array",
"items": {
"type": "object",
"required": [
"item_id",
"quantity"
],
"properties": {
"item_id": {
"description": "The ID of the Line Item from the Order.",
"type": "string"
},
"quantity": {
"description": "The quantity to swap.",
"type": "integer"
},
"reason_id": {
"description": "The ID of the reason of this return.",
"type": "string"
},
"note": {
"description": "The note to add to the item being swapped.",
"type": "string"
}
}
}
},
"return_shipping_option": {
"type": "string",
"description": "The ID of the Shipping Option to create the Shipping Method from."
},
"additional_items": {
"description": "The items to exchange the returned items to.",
"type": "array",
"items": {
"type": "object",
"required": [
"variant_id",
"quantity"
],
"properties": {
"variant_id": {
"description": "The ID of the Product Variant to send.",
"type": "string"
},
"quantity": {
"description": "The quantity to send of the variant.",
"type": "integer"
}
}
}
}
}
},
"StoreProductTagsListRes": {
"type": "object",
"required": [
"product_tags",
"count",
"offset",
"limit"
],
"properties": {
"product_tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductTag"
}
},
"count": {
"type": "integer",
"description": "The total number of items available"
},
"offset": {
"type": "integer",
"description": "The number of items skipped before these items"
},
"limit": {
"type": "integer",
"description": "The number of items per page"
}
}
},
"StoreProductTypesListRes": {
"type": "object",
"required": [
"product_types",
"count",
"offset",
"limit"
],
"properties": {
"product_types": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductType"
}
},
"count": {
"type": "integer",
"description": "The total number of items available"
},
"offset": {
"type": "integer",
"description": "The number of items skipped before these items"
},
"limit": {
"type": "integer",
"description": "The number of items per page"
}
}
},
"StoreProductsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "products",
"relations": [
"collection",
"images",
"options",
"options.values",
"tags",
"type",
"variants",
"variants.options",
"variants.prices"
],
"totals": [
"variants.purchasable"
]
},
"required": [
"products",
"count",
"offset",
"limit"
],
"properties": {
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricedProduct"
}
},
"count": {
"type": "integer",
"description": "The total number of items available"
},
"offset": {
"type": "integer",
"description": "The number of items skipped before these items"
},
"limit": {
"type": "integer",
"description": "The number of items per page"
}
}
},
"StoreProductsRes": {
"type": "object",
"x-expanded-relations": {
"field": "product",
"relations": [
"collection",
"images",
"options",
"options.values",
"tags",
"type",
"variants",
"variants.options",
"variants.prices"
],
"totals": [
"variants.purchasable"
]
},
"required": [
"product"
],
"properties": {
"product": {
"$ref": "#/components/schemas/PricedProduct"
}
}
},
"StoreRegionsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "regions",
"relations": [
"countries",
"payment_providers",
"fulfillment_providers"
],
"eager": [
"payment_providers",
"fulfillment_providers"
]
},
"required": [
"regions"
],
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Region"
}
}
}
},
"StoreRegionsRes": {
"type": "object",
"x-expanded-relations": {
"field": "region",
"relations": [
"countries",
"payment_providers",
"fulfillment_providers"
],
"eager": [
"payment_providers",
"fulfillment_providers"
]
},
"required": [
"region"
],
"properties": {
"region": {
"$ref": "#/components/schemas/Region"
}
}
},
"StoreReturnReasonsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "return_reasons",
"relations": [
"parent_return_reason",
"return_reason_children"
]
},
"required": [
"return_reasons"
],
"properties": {
"return_reasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnReason"
}
}
}
},
"StoreReturnReasonsRes": {
"type": "object",
"x-expanded-relations": {
"field": "return_reason",
"relations": [
"parent_return_reason",
"return_reason_children"
]
},
"required": [
"return_reason"
],
"properties": {
"return_reason": {
"$ref": "#/components/schemas/ReturnReason"
}
}
},
"StoreReturnsRes": {
"type": "object",
"x-expanded-relations": {
"field": "return",
"relations": [
"items",
"items.reason"
],
"eager": [
"items"
]
},
"required": [
"return"
],
"properties": {
"return": {
"$ref": "#/components/schemas/Return"
}
}
},
"StoreShippingOptionsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "shipping_options",
"relations": [
"requirements"
]
},
"required": [
"shipping_options"
],
"properties": {
"shipping_options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricedShippingOption"
}
}
}
},
"StoreSwapsRes": {
"type": "object",
"x-expanded-relations": {
"field": "swap",
"relations": [
"additional_items",
"additional_items.variant",
"cart",
"fulfillments",
"order",
"payment",
"return_order",
"return_order.shipping_method",
"shipping_address",
"shipping_methods"
],
"eager": [
"fulfillments.items"
]
},
"required": [
"swap"
],
"properties": {
"swap": {
"$ref": "#/components/schemas/Swap"
}
}
},
"StoreVariantsListRes": {
"type": "object",
"x-expanded-relations": {
"field": "variants",
"relations": [
"prices",
"options",
"product"
],
"totals": [
"purchasable"
]
},
"required": [
"variants"
],
"properties": {
"variants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PricedVariant"
}
}
}
},
"StoreVariantsRes": {
"type": "object",
"x-expanded-relations": {
"field": "variant",
"relations": [
"prices",
"options",
"product"
],
"totals": [
"purchasable"
]
},
"required": [
"variant"
],
"properties": {
"variant": {
"$ref": "#/components/schemas/PricedVariant"
}
}
},
"Swap": {
"title": "Swap",
"description": "Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference.",
"type": "object",
"required": [
"allow_backorder",
"canceled_at",
"cart_id",
"confirmed_at",
"created_at",
"deleted_at",
"difference_due",
"fulfillment_status",
"id",
"idempotency_key",
"metadata",
"no_notification",
"order_id",
"payment_status",
"shipping_address_id",
"updated_at"
],
"properties": {
"id": {
"description": "The swap's ID",
"type": "string",
"example": "swap_01F0YET86Y9G92D3YDR9Y6V676"
},
"fulfillment_status": {
"description": "The status of the Fulfillment of the Swap.",
"type": "string",
"enum": [
"not_fulfilled",
"fulfilled",
"shipped",
"partially_shipped",
"canceled",
"requires_action"
],
"example": "not_fulfilled"
},
"payment_status": {
"description": "The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.",
"type": "string",
"enum": [
"not_paid",
"awaiting",
"captured",
"confirmed",
"canceled",
"difference_refunded",
"partially_refunded",
"refunded",
"requires_action"
],
"example": "not_paid"
},
"order_id": {
"description": "The ID of the Order where the Line Items to be returned where purchased.",
"type": "string",
"example": "order_01G8TJSYT9M6AVS5N4EMNFS1EK"
},
"order": {
"description": "An order object. Available if the relation `order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Order"
},
"additional_items": {
"description": "The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/LineItem"
}
},
"return_order": {
"description": "A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Return"
},
"fulfillments": {
"description": "The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Fulfillment"
}
},
"payment": {
"description": "The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Payment"
},
"difference_due": {
"description": "The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products.",
"nullable": true,
"type": "integer",
"example": 0
},
"shipping_address_id": {
"description": "The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.",
"nullable": true,
"type": "string",
"example": "addr_01G8ZH853YPY9B94857DY91YGW"
},
"shipping_address": {
"description": "Available if the relation `shipping_address` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Address"
},
"shipping_methods": {
"description": "The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingMethod"
}
},
"cart_id": {
"description": "The id of the Cart that the Customer will use to confirm the Swap.",
"nullable": true,
"type": "string",
"example": "cart_01G8ZH853Y6TFXWPG5EYE81X63"
},
"cart": {
"description": "A cart object. Available if the relation `cart` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Cart"
},
"confirmed_at": {
"description": "The date with timezone at which the Swap was confirmed by the Customer.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"canceled_at": {
"description": "The date with timezone at which the Swap was canceled.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"no_notification": {
"description": "If set to true, no notification will be sent related to this swap",
"nullable": true,
"type": "boolean",
"example": false
},
"allow_backorder": {
"description": "If true, swaps can be completed with items out of stock",
"type": "boolean",
"default": false
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of the swap in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"TaxLine": {
"title": "Tax Line",
"description": "Line item that specifies an amount of tax to add to a line item.",
"type": "object",
"required": [
"code",
"created_at",
"id",
"metadata",
"name",
"rate",
"updated_at"
],
"properties": {
"id": {
"description": "The tax line's ID",
"type": "string",
"example": "tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8"
},
"code": {
"description": "A code to identify the tax type by",
"nullable": true,
"type": "string",
"example": "tax01"
},
"name": {
"description": "A human friendly name for the tax",
"type": "string",
"example": "Tax Example"
},
"rate": {
"description": "The numeric rate to charge tax by",
"type": "number",
"example": 10
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"TaxProvider": {
"title": "Tax Provider",
"description": "The tax service used to calculate taxes",
"type": "object",
"required": [
"id",
"is_installed"
],
"properties": {
"id": {
"description": "The id of the tax provider as given by the plugin.",
"type": "string",
"example": "manual"
},
"is_installed": {
"description": "Whether the plugin is installed in the current version. Plugins that are no longer installed are not deleted by will have this field set to `false`.",
"type": "boolean",
"default": true
}
}
},
"TaxRate": {
"title": "Tax Rate",
"description": "A Tax Rate can be used to associate a certain rate to charge on products within a given Region",
"type": "object",
"required": [
"code",
"created_at",
"id",
"metadata",
"name",
"rate",
"region_id",
"updated_at"
],
"properties": {
"id": {
"description": "The tax rate's ID",
"type": "string",
"example": "txr_01G8XDBAWKBHHJRKH0AV02KXBR"
},
"rate": {
"description": "The numeric rate to charge",
"nullable": true,
"type": "number",
"example": 10
},
"code": {
"description": "A code to identify the tax type by",
"nullable": true,
"type": "string",
"example": "tax01"
},
"name": {
"description": "A human friendly name for the tax",
"type": "string",
"example": "Tax Example"
},
"region_id": {
"description": "The id of the Region that the rate belongs to",
"type": "string",
"example": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G"
},
"region": {
"description": "A region object. Available if the relation `region` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Region"
},
"products": {
"description": "The products that belong to this tax rate. Available if the relation `products` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/Product"
}
},
"product_types": {
"description": "The product types that belong to this tax rate. Available if the relation `product_types` is expanded.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductType"
}
},
"shipping_options": {
"type": "array",
"description": "The shipping options that belong to this tax rate. Available if the relation `shipping_options` is expanded.",
"items": {
"$ref": "#/components/schemas/ShippingOption"
}
},
"product_count": {
"description": "The count of products",
"type": "integer",
"example": 10
},
"product_type_count": {
"description": "The count of product types",
"type": "integer",
"example": 2
},
"shipping_option_count": {
"description": "The count of shipping options",
"type": "integer",
"example": 1
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"TrackingLink": {
"title": "Tracking Link",
"description": "Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment.",
"type": "object",
"required": [
"created_at",
"deleted_at",
"fulfillment_id",
"id",
"idempotency_key",
"metadata",
"tracking_number",
"updated_at",
"url"
],
"properties": {
"id": {
"description": "The tracking link's ID",
"type": "string",
"example": "tlink_01G8ZH853Y6TFXWPG5EYE81X63"
},
"url": {
"description": "The URL at which the status of the shipment can be tracked.",
"nullable": true,
"type": "string",
"format": "uri"
},
"tracking_number": {
"description": "The tracking number given by the shipping carrier.",
"type": "string",
"format": "RH370168054CN"
},
"fulfillment_id": {
"description": "The id of the Fulfillment that the Tracking Link references.",
"type": "string",
"example": "ful_01G8ZRTMQCA76TXNAT81KPJZRF"
},
"fulfillment": {
"description": "Available if the relation `fulfillment` is expanded.",
"nullable": true,
"$ref": "#/components/schemas/Fulfillment"
},
"idempotency_key": {
"description": "Randomly generated key used to continue the completion of a process in case of failure.",
"nullable": true,
"type": "string",
"externalDocs": {
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
"description": "Learn more how to use the idempotency key."
}
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
},
"UpdateStockLocationInput": {
"title": "Update Stock Location Input",
"description": "Represents the Input to update a Stock Location",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The stock location name"
},
"address_id": {
"type": "string",
"description": "The Stock location address ID"
},
"address": {
"description": "Stock location address object",
"allOf": [
{
"$ref": "#/components/schemas/StockLocationAddressInput"
},
{
"type": "object"
}
]
},
"metadata": {
"type": "object",
"description": "An optional key-value map with additional details",
"example": {
"car": "white"
}
}
}
},
"User": {
"title": "User",
"description": "Represents a User who can manage store settings.",
"type": "object",
"required": [
"api_token",
"created_at",
"deleted_at",
"email",
"first_name",
"id",
"last_name",
"metadata",
"role",
"updated_at"
],
"properties": {
"id": {
"description": "The user's ID",
"type": "string",
"example": "usr_01G1G5V26F5TB3GPAPNJ8X1S3V"
},
"role": {
"description": "The user's role",
"type": "string",
"enum": [
"admin",
"member",
"developer"
],
"default": "member"
},
"email": {
"description": "The email of the User",
"type": "string",
"format": "email"
},
"first_name": {
"description": "The first name of the User",
"nullable": true,
"type": "string",
"example": "Levi"
},
"last_name": {
"description": "The last name of the User",
"nullable": true,
"type": "string",
"example": "Bogan"
},
"api_token": {
"description": "An API token associated with the user.",
"nullable": true,
"type": "string",
"example": null
},
"created_at": {
"description": "The date with timezone at which the resource was created.",
"type": "string",
"format": "date-time"
},
"updated_at": {
"description": "The date with timezone at which the resource was updated.",
"type": "string",
"format": "date-time"
},
"deleted_at": {
"description": "The date with timezone at which the resource was deleted.",
"nullable": true,
"type": "string",
"format": "date-time"
},
"metadata": {
"description": "An optional key-value map with additional details",
"nullable": true,
"type": "object",
"example": {
"car": "white"
}
}
}
}
}
}
}
Reference in New Issue View Git Blame Copy Permalink