chore(docs): Generated API Reference (v2) (#8318)

Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-07-29 09:41:02 +02:00
committed by GitHub
co-authored by kodiakhq
parent 56f634da4b
commit e40b4c6183
134 changed files with 7310 additions and 279 deletions
@@ -8,6 +8,7 @@ info:
tags:
- name: Api Keys
- name: Campaigns
- name: Claims
- name: Collections
x-associatedSchema:
$ref: "#/components/schemas/AdminCollection"
@@ -0,0 +1,100 @@
/**
* @oas [delete] /admin/claims/{id}/claim-items/{action_id}
* operationId: DeleteClaimsIdClaimItemsAction_id
* summary: Remove Claim Items from Claim
* description: Remove a list of claim items from a claim. This doesn't delete the
* Claim Item, only the association between the Claim Item and the claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,102 @@
/**
* @oas [delete] /admin/claims/{id}/inbound/items/{action_id}
* operationId: DeleteClaimsIdInboundItemsAction_id
* summary: Remove Items from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item,
* only the association between the Item and the claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,103 @@
/**
* @oas [delete] /admin/claims/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete
* the Shipping Method, only the association between the Shipping Method and the
* claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,102 @@
/**
* @oas [delete] /admin/claims/{id}/outbound/items/{action_id}
* operationId: DeleteClaimsIdOutboundItemsAction_id
* summary: Remove Items from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item,
* only the association between the Item and the claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,103 @@
/**
* @oas [delete] /admin/claims/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete
* the Shipping Method, only the association between the Shipping Method and the
* claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,88 @@
/**
* @oas [get] /admin/claims
* operationId: GetClaims
* summary: List Claims
* description: Retrieve a list of claims. The claims can be filtered by fields
* such as `id`. The claims can also be sorted or paginated.
* x-authenticated: true
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/claims' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -162,7 +162,6 @@
* description: The inventory item's weight.
* required: false
* schema:
* type: object
* description: The inventory item's weight.
* required:
* - $eq
@@ -195,7 +194,6 @@
* description: The inventory item's length.
* required: false
* schema:
* type: object
* description: The inventory item's length.
* required:
* - $eq
@@ -228,7 +226,6 @@
* description: The inventory item's height.
* required: false
* schema:
* type: object
* description: The inventory item's height.
* required:
* - $eq
@@ -261,7 +258,6 @@
* description: The inventory item's width.
* required: false
* schema:
* type: object
* description: The inventory item's width.
* required:
* - $eq
@@ -99,7 +99,7 @@
* description: The invite's created at.
* required: false
* schema:
* type: object
* type: string
* description: The invite's created at.
* required:
* - $eq
@@ -127,12 +127,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The invite's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The invite's updated at.
* required:
* - $eq
@@ -160,12 +161,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The invite's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The invite's deleted at.
* required:
* - $eq
@@ -193,6 +195,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -97,7 +97,7 @@
* description: The payment's created at.
* required: false
* schema:
* type: object
* type: string
* description: The payment's created at.
* required:
* - $eq
@@ -125,12 +125,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The payment's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The payment's updated at.
* required:
* - $eq
@@ -158,12 +159,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The payment's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The payment's deleted at.
* required:
* - $eq
@@ -191,6 +193,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -158,7 +158,7 @@
* description: The product category's created at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's created at.
* required:
* - $eq
@@ -186,12 +186,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The product category's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's updated at.
* required:
* - $eq
@@ -219,12 +220,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The product category's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's deleted at.
* required:
* - $eq
@@ -252,6 +254,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -97,7 +97,7 @@
* description: The product tag's created at.
* required: false
* schema:
* type: object
* type: string
* description: The product tag's created at.
* required:
* - $eq
@@ -125,12 +125,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The product tag's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The product tag's updated at.
* required:
* - $eq
@@ -158,12 +159,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The product tag's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The product tag's deleted at.
* required:
* - $eq
@@ -191,6 +193,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -97,7 +97,7 @@
* description: The product type's created at.
* required: false
* schema:
* type: object
* type: string
* description: The product type's created at.
* required:
* - $eq
@@ -125,12 +125,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The product type's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The product type's updated at.
* required:
* - $eq
@@ -158,12 +159,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The product type's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The product type's deleted at.
* required:
* - $eq
@@ -191,6 +193,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -116,7 +116,7 @@
* description: The promotion's created at.
* required: false
* schema:
* type: object
* type: string
* description: The promotion's created at.
* required:
* - $eq
@@ -144,12 +144,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The promotion's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The promotion's updated at.
* required:
* - $eq
@@ -177,12 +178,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The promotion's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The promotion's deleted at.
* required:
* - $eq
@@ -210,6 +212,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -111,7 +111,7 @@
* description: The region's created at.
* required: false
* schema:
* type: object
* type: string
* description: The region's created at.
* required:
* - $eq
@@ -139,12 +139,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The region's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The region's updated at.
* required:
* - $eq
@@ -172,12 +173,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The region's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The region's deleted at.
* required:
* - $eq
@@ -205,6 +207,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -153,7 +153,6 @@
* description: The reservation's quantity.
* required: false
* schema:
* type: object
* description: The reservation's quantity.
* required:
* - $eq
@@ -186,7 +185,7 @@
* description: The reservation's created at.
* required: false
* schema:
* type: object
* type: string
* description: The reservation's created at.
* required:
* - $eq
@@ -214,12 +213,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The reservation's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The reservation's updated at.
* required:
* - $eq
@@ -247,12 +247,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The reservation's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The reservation's deleted at.
* required:
* - $eq
@@ -280,6 +281,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -114,7 +114,7 @@
* description: The sales channel's created at.
* required: false
* schema:
* type: object
* type: string
* description: The sales channel's created at.
* required:
* - $eq
@@ -142,12 +142,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The sales channel's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The sales channel's updated at.
* required:
* - $eq
@@ -175,12 +176,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The sales channel's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The sales channel's deleted at.
* required:
* - $eq
@@ -208,6 +210,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: location_id
* in: query
* required: false
@@ -140,7 +140,7 @@
* description: The shipping option's created at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping option's created at.
* required:
* - $eq
@@ -168,12 +168,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The shipping option's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping option's updated at.
* required:
* - $eq
@@ -201,12 +202,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The shipping option's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping option's deleted at.
* required:
* - $eq
@@ -234,6 +236,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* security:
* - api_token: []
* - cookie_auth: []
@@ -100,7 +100,7 @@
* description: The shipping profile's created at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping profile's created at.
* required:
* - $eq
@@ -128,12 +128,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The shipping profile's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping profile's updated at.
* required:
* - $eq
@@ -161,12 +162,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The shipping profile's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The shipping profile's deleted at.
* required:
* - $eq
@@ -194,6 +196,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -126,7 +126,7 @@
* description: The stock location's created at.
* required: false
* schema:
* type: object
* type: string
* description: The stock location's created at.
* required:
* - $eq
@@ -154,12 +154,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The stock location's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The stock location's updated at.
* required:
* - $eq
@@ -187,12 +188,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The stock location's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The stock location's deleted at.
* required:
* - $eq
@@ -220,6 +222,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -119,7 +119,7 @@
* description: The tax rate's created at.
* required: false
* schema:
* type: object
* type: string
* description: The tax rate's created at.
* required:
* - $eq
@@ -147,12 +147,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The tax rate's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The tax rate's updated at.
* required:
* - $eq
@@ -180,12 +181,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The tax rate's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The tax rate's deleted at.
* required:
* - $eq
@@ -213,6 +215,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -223,7 +223,7 @@
* description: The tax region's created at.
* required: false
* schema:
* type: object
* type: string
* description: The tax region's created at.
* required:
* - $eq
@@ -251,12 +251,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The tax region's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The tax region's updated at.
* required:
* - $eq
@@ -284,12 +285,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The tax region's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The tax region's deleted at.
* required:
* - $eq
@@ -317,6 +319,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -0,0 +1,98 @@
/**
* @oas [post] /admin/claims
* operationId: PostClaims
* summary: Create Claim
* description: Create a claim.
* x-authenticated: true
* parameters:
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostOrderClaimsReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "type": "{value}",
* "order_id": "{value}",
* "metadata": {}
* }'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,98 @@
/**
* @oas [post] /admin/claims/{id}/claim-items
* operationId: PostClaimsIdClaimItems
* summary: Add Claim Items to Claim
* description: Add a list of claim items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimItemsReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/claim-items' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,104 @@
/**
* @oas [post] /admin/claims/{id}/claim-items/{action_id}
* operationId: PostClaimsIdClaimItemsAction_id
* summary: Add Claim Items to Claim
* description: Add a list of claim items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/claim-items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,98 @@
/**
* @oas [post] /admin/claims/{id}/inbound/items
* operationId: PostClaimsIdInboundItems
* summary: Add Items to Claim
* description: Add a list of items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostReturnsRequestItemsReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/inbound/items' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,104 @@
/**
* @oas [post] /admin/claims/{id}/inbound/items/{action_id}
* operationId: PostClaimsIdInboundItemsAction_id
* summary: Add Items to Claim
* description: Add a list of items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,102 @@
/**
* @oas [post] /admin/claims/{id}/inbound/shipping-method
* operationId: PostClaimsIdInboundShippingMethod
* summary: Add Shipping Methods to Claim
* description: Add a list of shipping methods to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostReturnsShippingReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/inbound/shipping-method' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "shipping_option_id": "{value}"
* }'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,106 @@
/**
* @oas [post] /admin/claims/{id}/inbound/shipping-method/{action_id}
* operationId: PostClaimsIdInboundShippingMethodAction_id
* summary: Add Shipping Methods to Claim
* description: Add a list of shipping methods to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,98 @@
/**
* @oas [post] /admin/claims/{id}/outbound/items
* operationId: PostClaimsIdOutboundItems
* summary: Add Items to Claim
* description: Add a list of items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsAddItemsReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/outbound/items' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,106 @@
/**
* @oas [post] /admin/claims/{id}/outbound/items/{action_id}
* operationId: PostClaimsIdOutboundItemsAction_id
* summary: Add Items to Claim
* description: Add a list of items to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST '{backend_url}/admin/claims/{id}/outbound/items/{action_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,102 @@
/**
* @oas [post] /admin/claims/{id}/outbound/shipping-method
* operationId: PostClaimsIdOutboundShippingMethod
* summary: Add Shipping Methods to Claim
* description: Add a list of shipping methods to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsShippingReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/claims/{id}/outbound/shipping-method' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "shipping_option_id": "{value}"
* }'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,106 @@
/**
* @oas [post] /admin/claims/{id}/outbound/shipping-method/{action_id}
* operationId: PostClaimsIdOutboundShippingMethodAction_id
* summary: Add Shipping Methods to Claim
* description: Add a list of shipping methods to a claim.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The claim's ID.
* required: true
* schema:
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims
* 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"
*
*/
@@ -0,0 +1,95 @@
/**
* @oas [post] /admin/products/import/{transaction_id}/confirm
* operationId: PostProductsImportTransaction_idConfirm
* summary: Add Confirms to Product
* description: Add a list of confirms to a product.
* x-authenticated: true
* parameters:
* - name: transaction_id
* in: path
* description: The product's transaction id.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/products/import/{transaction_id}/confirm' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Products
* responses:
* "202":
* 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"
*
*/
@@ -0,0 +1,102 @@
/**
* @oas [post] /admin/returns/{id}
* operationId: PostReturnsId
* summary: Update a Return
* description: Update a return's details.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The return's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminPostReturnsReturnReqSchema"
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X POST '{backend_url}/admin/returns/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "metadata": {}
* }'
* tags:
* - Returns
* 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"
*
*/
@@ -0,0 +1,116 @@
/**
* @oas [post] /admin/stock-locations/{id}/fulfillment-providers
* operationId: PostStockLocationsIdFulfillmentProviders
* summary: Add Fulfillment Providers to Stock Location
* description: Add a list of fulfillment providers to a stock location.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The stock location's ID.
* required: true
* schema:
* type: string
* - name: expand
* in: query
* description: Comma-separated relations that should be expanded in the returned data.
* required: false
* schema:
* type: string
* title: expand
* description: Comma-separated relations that should be expanded in the returned data.
* - name: fields
* in: query
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* required: false
* schema:
* type: string
* title: fields
* description: >-
* Comma-separated fields that should be included in the returned data.
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* * without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is
* ascending. To change the order to descending, prefix the field name with
* `-`.
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* properties:
* add:
* type: array
* description: The stock location's add.
* items:
* type: string
* title: add
* description: The add's details.
* remove:
* type: array
* description: The stock location's remove.
* items:
* type: string
* title: remove
* description: The remove's details.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X POST
* '{backend_url}/admin/stock-locations/{id}/fulfillment-providers' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Stock Locations
* 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"
*
*/
@@ -142,7 +142,7 @@
* description: The product category's created at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's created at.
* required:
* - $eq
@@ -170,12 +170,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The product category's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's updated at.
* required:
* - $eq
@@ -203,12 +204,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The product category's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The product category's deleted at.
* required:
* - $eq
@@ -236,6 +238,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: $and
* in: query
* required: false
@@ -213,7 +213,7 @@
* description: The product's created at.
* required: false
* schema:
* type: object
* type: string
* description: The product's created at.
* required:
* - $eq
@@ -241,12 +241,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: created_at
* - name: updated_at
* in: query
* description: The product's updated at.
* required: false
* schema:
* type: object
* type: string
* description: The product's updated at.
* required:
* - $eq
@@ -274,12 +275,13 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: updated_at
* - name: deleted_at
* in: query
* description: The product's deleted at.
* required: false
* schema:
* type: object
* type: string
* description: The product's deleted at.
* required:
* - $eq
@@ -307,6 +309,7 @@
* $gte: {}
* $lt: {}
* $lte: {}
* title: deleted_at
* - name: country_code
* in: query
* description: The product's country code.
@@ -4,12 +4,12 @@
* description: SUMMARY
* x-schemaName: AdminExportProductResponse
* required:
* - workflow_id
* - transaction_id
* properties:
* workflow_id:
* transaction_id:
* type: string
* title: workflow_id
* description: The product's workflow id.
* title: transaction_id
* description: The product's transaction id.
*
*/
@@ -4,12 +4,28 @@
* description: SUMMARY
* x-schemaName: AdminImportProductResponse
* required:
* - workflow_id
* - transaction_id
* - summary
* properties:
* workflow_id:
* transaction_id:
* type: string
* title: workflow_id
* description: The product's workflow id.
* title: transaction_id
* description: The product's transaction id.
* summary:
* type: object
* description: The product's summary.
* required:
* - toCreate
* - toUpdate
* properties:
* toCreate:
* type: number
* title: toCreate
* description: The summary's tocreate.
* toUpdate:
* type: number
* title: toUpdate
* description: The summary's toupdate.
*
*/
@@ -0,0 +1,38 @@
/**
* @schema AdminPostClaimItemsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimItemsReqSchema
* properties:
* items:
* type: array
* description: The claim's items.
* items:
* type: object
* description: The item's items.
* required:
* - id
* - quantity
* properties:
* id:
* type: string
* title: id
* description: The item's ID.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* description:
* type: string
* title: description
* description: The item's description.
* internal_note:
* type: string
* title: internal_note
* description: The item's internal note.
* metadata:
* type: object
* description: The item's metadata.
*
*/
@@ -0,0 +1,38 @@
/**
* @schema AdminPostClaimsAddItemsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsAddItemsReqSchema
* properties:
* items:
* type: array
* description: The claim's items.
* items:
* type: object
* description: The item's items.
* required:
* - variant_id
* - quantity
* properties:
* variant_id:
* type: string
* title: variant_id
* description: The item's variant id.
* quantity:
* type: number
* title: quantity
* description: The item's quantity.
* unit_price:
* type: number
* title: unit_price
* description: The item's unit price.
* internal_note:
* type: string
* title: internal_note
* description: The item's internal note.
* metadata:
* type: object
* description: The item's metadata.
*
*/
@@ -0,0 +1,17 @@
/**
* @schema AdminPostClaimsItemsActionReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsItemsActionReqSchema
* properties:
* quantity:
* type: number
* title: quantity
* description: The claim's quantity.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
*
*/
@@ -0,0 +1,20 @@
/**
* @schema AdminPostClaimsShippingActionReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsShippingActionReqSchema
* properties:
* custom_price:
* type: number
* title: custom_price
* description: The claim's custom price.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
@@ -0,0 +1,30 @@
/**
* @schema AdminPostClaimsShippingReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostClaimsShippingReqSchema
* required:
* - shipping_option_id
* properties:
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The claim's shipping option id.
* custom_price:
* type: number
* title: custom_price
* description: The claim's custom price.
* description:
* type: string
* title: description
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
@@ -0,0 +1,33 @@
/**
* @schema AdminPostOrderClaimsReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostOrderClaimsReqSchema
* required:
* - type
* - order_id
* - metadata
* properties:
* type:
* type: string
* enum:
* - refund
* - replace
* order_id:
* type: string
* title: order_id
* description: The claim's order id.
* description:
* type: string
* title: description
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The claim's internal note.
* metadata:
* type: object
* description: The claim's metadata.
*
*/
@@ -7,18 +7,18 @@
* quantity:
* type: number
* title: quantity
* description: The return's quantity.
* description: The claim's quantity.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
* description: The claim's internal note.
* reason_id:
* type: string
* title: reason_id
* description: The return's reason id.
* description: The claim's reason id.
* metadata:
* type: object
* description: The return's metadata.
* description: The claim's metadata.
*
*/
@@ -6,7 +6,7 @@
* properties:
* items:
* type: array
* description: The return's items.
* description: The claim's items.
* items:
* type: object
* description: The item's items.
@@ -0,0 +1,22 @@
/**
* @schema AdminPostReturnsReturnReqSchema
* type: object
* description: SUMMARY
* x-schemaName: AdminPostReturnsReturnReqSchema
* required:
* - metadata
* properties:
* location_id:
* type: string
* title: location_id
* description: The return's location id.
* no_notification:
* type: boolean
* title: no_notification
* description: The return's no notification.
* metadata:
* type: object
* description: The return's metadata.
*
*/
@@ -9,22 +9,22 @@
* shipping_option_id:
* type: string
* title: shipping_option_id
* description: The return's shipping option id.
* description: The claim's shipping option id.
* custom_price:
* type: number
* title: custom_price
* description: The return's custom price.
* description: The claim's custom price.
* description:
* type: string
* title: description
* description: The return's description.
* description: The claim's description.
* internal_note:
* type: string
* title: internal_note
* description: The return's internal note.
* description: The claim's internal note.
* metadata:
* type: object
* description: The return's metadata.
* description: The claim's metadata.
*
*/
@@ -83,13 +83,13 @@
* type: string
* title: id
* description: The parent's ID.
* metadata:
* type: object
* description: The parent's metadata.
* handle:
* type: string
* title: handle
* description: The parent's handle.
* metadata:
* type: object
* description: The parent's metadata.
* hs_code:
* type: string
* title: hs_code
@@ -66,13 +66,13 @@
* type: string
* title: id
* description: The product's ID.
* metadata:
* type: object
* description: The product's metadata.
* handle:
* type: string
* title: handle
* description: The product's handle.
* metadata:
* type: object
* description: The product's metadata.
* hs_code:
* type: string
* title: hs_code