docs: generate OAS for 2.11.2 (#13925)
This commit is contained in:
Shahed Nasser authored and 
GitHub committed
1 parent
13d7d15be5
commit
604ff55a5b
403 files changed
+17473
-5392
No files matched your search
@@ -181,6 +181,12 @@ tags:
|
||||
</Note>
|
||||
x-associatedSchema:
|
||||
$ref: "#/components/schemas/AdminGiftCard"
|
||||
- name: Index
|
||||
description: >
|
||||
The Index Module is a tool to perform high-performance queries across modules, for example, to filter linked modules.
|
||||
|
||||
The Index Module is currently experimental and is hidden behind a feature flag. Learn more about it and how
|
||||
to enable it in the [Index Module guide](https://docs.medusajs.com/learn/fundamentals/module-links/index-module).
|
||||
- name: Inventory Items
|
||||
description: |
|
||||
An inventory item is a stock-kept product whose inventory is managed.
|
||||
|
||||
@@ -53,6 +53,55 @@
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted records in the result.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: Apply a search query to the campaign's searchable properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Apply a search query to the campaign's searchable properties.
|
||||
* - name: campaign_identifier
|
||||
* in: query
|
||||
* description: Filter by a campaign identifier.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: campaign_identifier
|
||||
* description: Filter by a campaign identifier.
|
||||
* - name: budget
|
||||
* in: query
|
||||
* description: Filter by the campaign's budget.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the campaign's budget.
|
||||
* properties:
|
||||
* currency_code:
|
||||
* type: string
|
||||
* title: currency_code
|
||||
* description: The budget's currency code.
|
||||
* example: "usd"
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -47,11 +47,11 @@
|
||||
* 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 `-`.
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: The claim's deleted at.
|
||||
* description: Filter by the claim's deletion date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The claim's deleted at.
|
||||
* description: The claim's deletion date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -319,20 +319,20 @@
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: The claim's status.
|
||||
* description: Filter by the claim's status.
|
||||
* - type: array
|
||||
* description: The claim's status.
|
||||
* description: Filter by the claim's status.
|
||||
* items:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The status's details.
|
||||
* description: The claim's status.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: The claim's created at.
|
||||
* description: Filter by the claim's creation date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The claim's created at.
|
||||
* description: The claim's creation date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -559,11 +559,11 @@
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: The claim's updated at.
|
||||
* description: Filter by the claim's update date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The claim's updated at.
|
||||
* description: The claim's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
/**
|
||||
* @oas [get] /admin/index/details
|
||||
* operationId: GetIndexDetails
|
||||
* summary: Get Index Details
|
||||
* description: Retrieve index metadata, including entity type, status, last synced key, and last updated timestamp.
|
||||
* x-authenticated: true
|
||||
* parameters: []
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl '{backend_url}/admin/index/details' \
|
||||
* -H 'Authorization: Bearer {access_token}'
|
||||
* tags:
|
||||
* - Index
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminIndexDetailsResponse"
|
||||
* "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"
|
||||
* x-since: 2.11.2
|
||||
* x-featureFlag: index
|
||||
*
|
||||
*/
|
||||
|
||||
+14
-18
@@ -51,24 +51,6 @@
|
||||
* 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 `-`.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: Whether to include deleted records in the result.
|
||||
@@ -77,6 +59,20 @@
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted records in the result.
|
||||
* - name: location_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: location_id
|
||||
* description: Filter by the inventory item's location ID.
|
||||
* - type: array
|
||||
* description: The inventory item's location IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: location_id
|
||||
* description: The location ID.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -23,34 +23,6 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: The order's ID.
|
||||
* - type: array
|
||||
* description: The order's ID.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The id's ID.
|
||||
* - name: status
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: The order's status.
|
||||
* - type: array
|
||||
* description: The order's status.
|
||||
* items:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: The status's details.
|
||||
* - name: version
|
||||
* in: query
|
||||
* description: The order's version.
|
||||
@@ -59,18 +31,6 @@
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The order's version.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* required: false
|
||||
* schema: {}
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
* description: |
|
||||
* Retrieve a list of changes made on an order, including returns, exchanges, etc...
|
||||
*
|
||||
* The changes can be filtered by fields like FILTER FIELDS. The changes can also be paginated.
|
||||
* The changes can be filtered by fields like `created_at`. The changes can also be paginated.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
@@ -29,6 +29,806 @@
|
||||
* 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: created_at
|
||||
* in: query
|
||||
* description: Filter by the order change's creation date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the order change's creation date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: Filter by the order change's update date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the order change's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: Filter by the order change's deletion date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the order change's deletion date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: Filter by an order change ID.
|
||||
* - type: array
|
||||
* description: Filter by order change IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: An order change ID.
|
||||
* - type: object
|
||||
* description: The order's ID.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* - name: status
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: Filter by the order change's status.
|
||||
* - type: array
|
||||
* description: Filter by multiple order change statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: An order change status.
|
||||
* - type: object
|
||||
* description: The order change's status.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* - name: change_type
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: change_type
|
||||
* description: Filter by the order change's type.
|
||||
* - type: array
|
||||
* description: Filter by multiple order change types.
|
||||
* items:
|
||||
* type: string
|
||||
* title: change_type
|
||||
* description: An order change type.
|
||||
* - type: object
|
||||
* description: Filter the order change's type.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -67,36 +67,6 @@
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The version's details.
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -47,6 +47,851 @@
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* - name: is_internal
|
||||
* in: query
|
||||
* description: Filter by whether the product category is internal.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_internal
|
||||
* description: Filter by whether the product category is internal.
|
||||
* - name: is_active
|
||||
* in: query
|
||||
* description: Filter by whether the product category is active.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_active
|
||||
* description: Filter by whether the product category is active.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: Apply a search query to the product category's searchable properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Apply a search query to the product category's searchable properties.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: Filter by the product category's ID.
|
||||
* - type: array
|
||||
* description: Filter by product category IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: A product category ID.
|
||||
* - name: name
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: name
|
||||
* description: Filter by the product category's name.
|
||||
* - type: array
|
||||
* description: Filter by product category names.
|
||||
* items:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: A product category name.
|
||||
* - name: description
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: description
|
||||
* description: Filter by the product category's description.
|
||||
* - type: array
|
||||
* description: Filter by product category descriptions.
|
||||
* items:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: A product category description.
|
||||
* - name: parent_category_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: parent_category_id
|
||||
* description: Retrieve the categories of a given parent category's ID.
|
||||
* - type: array
|
||||
* description: Retrieve the categories of the given parent category IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: parent_category_id
|
||||
* description: A parent category ID.
|
||||
* - name: handle
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: handle
|
||||
* description: Filter by the product category's handle.
|
||||
* - type: array
|
||||
* description: Filter by product category handles.
|
||||
* items:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: A product category handle.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: Filter by the category's creation date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the category's creation date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: Filter by the category's update date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the category's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: Filter by the category's deletion date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by the category's deletion date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: An exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value not to match.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by multiple exact matches.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: The value to match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not matching this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: The value to match.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: The value to not match
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching this parameter
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The value to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - type: array
|
||||
* description: Filter by values not matching those in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: The values to not match.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: The values to match.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: The values to match.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: The values to match.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: The product category's with deleted.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: The product category's with deleted.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -724,7 +724,7 @@
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* updated_at:
|
||||
* type: object
|
||||
* description: The variant's updated at.
|
||||
* description: Filter by the variant's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
@@ -985,35 +985,47 @@
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: ean
|
||||
* description: The variant's ean.
|
||||
* description: Filter by a variant's ean.
|
||||
* - type: array
|
||||
* description: The variant's ean.
|
||||
* description: Filter by variant eans.
|
||||
* items:
|
||||
* type: string
|
||||
* title: ean
|
||||
* description: The ean's details.
|
||||
* description: A variant's ean.
|
||||
* upc:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: upc
|
||||
* description: The variant's upc.
|
||||
* description: Filter by a variant's upc.
|
||||
* - type: array
|
||||
* description: The variant's upc.
|
||||
* description: Filter by variant upcs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: upc
|
||||
* description: The upc's details.
|
||||
* description: A variant's upc.
|
||||
* barcode:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: barcode
|
||||
* description: The variant's barcode.
|
||||
* description: Filter by a variant's barcode.
|
||||
* - type: array
|
||||
* description: The variant's barcode.
|
||||
* description: Filter by variant barcodes.
|
||||
* items:
|
||||
* type: string
|
||||
* title: barcode
|
||||
* description: The barcode's details.
|
||||
* description: A variant's barcode.
|
||||
* with_deleted:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted variants.
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: Whether to include deleted products.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted products.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+31
@@ -38,6 +38,37 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: promotion_type
|
||||
* in: query
|
||||
* description: The type
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's type.
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method type.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* - name: application_method_target_type
|
||||
* in: query
|
||||
* description: The promotion's application method target type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method target type.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+34
-23
@@ -52,28 +52,6 @@
|
||||
* 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 `-`.
|
||||
* - name: promotion_type
|
||||
* in: query
|
||||
* description: The promotion type to retrieve rules for.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: promotion_type
|
||||
* description: The promotion type to retrieve rules for.
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The application method type to retrieve rules for.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: application_method_type
|
||||
* description: The application method type to retrieve rules for.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: Whether to include deleted records in the result.
|
||||
@@ -88,8 +66,41 @@
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: application_method_target_type
|
||||
* description: The application method target type to retrieve rules for.
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: Apply a search query on the rule values' searchable properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Apply a search query on the rule values' searchable properties.
|
||||
* - name: value
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: value
|
||||
* description: Filter by a specific rule value.
|
||||
* - type: array
|
||||
* description: Filter by multiple rule values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: A rule value.
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -519,20 +519,133 @@
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted records in the result.
|
||||
* - name: order_id
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: Apply a search query on the reservation's searchable properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: order_id
|
||||
* description: Filter by an order's ID to retrieve its associated reservations.
|
||||
* - type: array
|
||||
* description: Filter by multiple order IDs to retrieve their associated reservations.
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Apply a search query on the reservation's searchable properties.
|
||||
* - name: quantity
|
||||
* in: query
|
||||
* description: Filter by the reservation's quantity.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a reservation's quantity.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: order_id
|
||||
* description: An order's ID.
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -23,30 +23,6 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: province_code
|
||||
* in: query
|
||||
* description: Filter by a tax region's province code.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: province_code
|
||||
* description: Filter by a tax region's province code.
|
||||
* - name: provider_id
|
||||
* in: query
|
||||
* description: Filter by a tax provider ID to retrieve the tax regions using it.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: provider_id
|
||||
* description: Filter by a tax provider ID to retrieve the tax regions using it.
|
||||
* - name: metadata
|
||||
* in: query
|
||||
* description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a tax region's metadata. Refer to the [Object Query Parameter](https://docs.medusajs.com/api/admin#object) section to learn how to filter by object fields.
|
||||
* title: metadata
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The sales channels to add or remove from the publishable API key.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The sales channels to add to the publishable API key.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A sales channel's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The sales channels to remove from the publishable API key.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A sales channel's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The promotions to add or remove from the campaign.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The promotions to add to the campaign.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A promotion's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The promotions to remove from the campaign.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A promotion's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -17,6 +17,391 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: Filter by the claim's ID.
|
||||
* - type: array
|
||||
* description: Filter by multiple claim IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: A claim ID.
|
||||
* - name: status
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: Filter by the claim's status.
|
||||
* - type: array
|
||||
* description: Filter by multiple claim statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* title: status
|
||||
* description: A claim status.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: Filter by a claim's creation date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a claim's creation date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: Filter by a claim's update date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a claim's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: Filter by a claim's deletion date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a claim's deletion date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -25,7 +410,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostOrderClaimsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminCreateClaim"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddClaimItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -40,7 +40,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateClaimItem"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminClaimUpdateInboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -33,7 +33,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsAddItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddClaimOutboundItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsItemsActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateClaimOutboundItem"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -33,7 +33,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsShippingReqSchema"
|
||||
* $ref: "#/components/schemas/AdminClaimAddOutboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostClaimsShippingActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminClaimUpdateOutboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The products to add or remove.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The products to add to the collection.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A product's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The products to remove from the collection.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A product's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The customers to add or remove from the group.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The customers to add to the group.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A customer's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The customers to remove from the group.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A customer's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -36,23 +36,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: SUMMARY
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The customer groups to add the customer to.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: The ID of the group to add the customer to.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The customer groups to remove the customer from.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: The ID of the group to remove the customer from.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+9
-14
@@ -12,20 +12,6 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -58,6 +44,10 @@
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminOrderResponse"
|
||||
* "400":
|
||||
* $ref: "#/components/responses/400_error"
|
||||
* "401":
|
||||
@@ -83,6 +73,11 @@
|
||||
* Emitted when an order is placed, or when a draft order is converted to an
|
||||
* order.
|
||||
* deprecated: false
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminDraftOrderParams"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostOrderExchangesReqSchema"
|
||||
* $ref: "#/components/schemas/AdminCreateExchange"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+13
-1
@@ -12,6 +12,18 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -20,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddExchangeInboundItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminExchangeUpdateInboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesAddItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddExchangeOutboundItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesItemsActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateExchangeOutboundItem"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesShippingReqSchema"
|
||||
* $ref: "#/components/schemas/AdminExchangeAddOutboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostExchangesShippingActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminExchangeUpdateOutboundShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreateFulfillmentSetServiceZones"
|
||||
* $ref: "#/components/schemas/AdminCreateFulfillmentSetServiceZone"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminUpdateFulfillmentSetServiceZones"
|
||||
* $ref: "#/components/schemas/AdminUpdateFulfillmentSetServiceZone"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreateShipment"
|
||||
* $ref: "#/components/schemas/AdminCreateFulfillmentShipment"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
/**
|
||||
* @oas [post] /admin/index/sync
|
||||
* operationId: PostIndexSync
|
||||
* summary: Trigger Index Sync
|
||||
* description: Trigger reindexing or re-ingestion of the Index Module.
|
||||
* x-authenticated: true
|
||||
* parameters: []
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminIndexSyncPayload"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/admin/index/sync' \
|
||||
* -H 'Authorization: Bearer {access_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "strategy": "full"
|
||||
* }'
|
||||
* tags:
|
||||
* - Index
|
||||
* 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"
|
||||
* x-since: 2.11.2
|
||||
* x-featureFlag: index
|
||||
*
|
||||
*/
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreateInventoryLocationLevel"
|
||||
* $ref: "#/components/schemas/AdminBatchCreateInventoryItemLocationLevels"
|
||||
* x-codeSamples:
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminUpdateInventoryLocationLevel"
|
||||
* $ref: "#/components/schemas/AdminUpdateInventoryLevel"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -25,6 +25,14 @@
|
||||
* fields. Without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: version
|
||||
* in: query
|
||||
* description: The version of the order to retrieve.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: version
|
||||
* description: The version of the order to retrieve.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+1
-1
@@ -34,7 +34,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreateOrderCreditLines"
|
||||
* $ref: "#/components/schemas/AdminCreateOrderCreditLine"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
-12
@@ -17,18 +17,6 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -35,7 +35,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminTransferOrder"
|
||||
* $ref: "#/components/schemas/AdminRequestOrderTransfer"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminMarkPaymentCollectionPaid"
|
||||
* $ref: "#/components/schemas/AdminMarkPaymentCollectionAsPaid"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreatePaymentCapture"
|
||||
* $ref: "#/components/schemas/AdminCapturePayment"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminCreatePaymentRefund"
|
||||
* $ref: "#/components/schemas/AdminRefundPayment"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -17,6 +17,348 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: Apply a search query to the price list's searchable properties.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Apply a search query to the price list's searchable properties.
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: Filter by a specific price list ID.
|
||||
* - type: array
|
||||
* description: Filter by multiple price list IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: A price list ID.
|
||||
* - name: starts_at
|
||||
* in: query
|
||||
* description: Filter by a price list's start date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a price list's start date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: ends_at
|
||||
* in: query
|
||||
* description: Filter by a price list's end date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a price list's end date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: status
|
||||
* in: query
|
||||
* description: Filter by price list statuses.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by price list statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A price list status.
|
||||
* enum:
|
||||
* - draft
|
||||
* - active
|
||||
* - name: rules_count
|
||||
* in: query
|
||||
* description: Filter by multiple price list rules count.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Filter by price list rules count.
|
||||
* items:
|
||||
* type: number
|
||||
* title: rules_count
|
||||
* description: A price list's rules count.
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: The price list's with deleted.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: The price list's with deleted.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -19,44 +19,28 @@
|
||||
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: offset
|
||||
* - name: include_ancestors_tree
|
||||
* 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: Whether to include deleted records in the result.
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted records in the result.
|
||||
* title: include_ancestors_tree
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -25,6 +25,28 @@
|
||||
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+23
-17
@@ -26,6 +26,28 @@
|
||||
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: include_ancestors_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_ancestors_tree
|
||||
* description: Whether to retrieve the category's parent. If you enable this, add to the `fields` query parameter `parent_category` to set the parent of a category in this field. You can either pass
|
||||
* `*parent_category` to retreieve the fields of all parent categories, or select specific fields to make the response size smaller. For example, `fields=parent_category.id,parent_category.name`.
|
||||
* - name: include_descendants_tree
|
||||
* in: query
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: include_descendants_tree
|
||||
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the child of a category in this field. You can either
|
||||
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
|
||||
* `fields=category_children.id,category_children.name`.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -34,23 +56,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The products to add or remove from the category.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The products to add.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A product ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The product to remove.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A product ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
/**
|
||||
* @oas [post] /admin/products/{id}/images/{image_id}/variants/batch
|
||||
* operationId: PostProductsIdImagesImage_idVariantsBatch
|
||||
* summary: Manage Variants of Product Image
|
||||
* description: Manage the association between product variants and a product image. You can add or remove associations between variants and the image.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The product's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: image_id
|
||||
* in: path
|
||||
* description: The product image's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminBatchImageVariantRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
* source: |-
|
||||
* import Medusa from "@medusajs/js-sdk"
|
||||
*
|
||||
* export const sdk = new Medusa({
|
||||
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
* debug: import.meta.env.DEV,
|
||||
* auth: {
|
||||
* type: "session",
|
||||
* },
|
||||
* })
|
||||
*
|
||||
* sdk.admin.product.batchImageVariants("prod_123", "img_123", {
|
||||
* add: ["variant_123", "variant_456"],
|
||||
* remove: ["variant_789"]
|
||||
* })
|
||||
* .then(({ added, removed }) => {
|
||||
* console.log(added, removed)
|
||||
* })
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/admin/products/{id}/images/{image_id}/variants/batch' \
|
||||
* -H 'Authorization: Bearer {access_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "add": ["variant_123", "variant_456"],
|
||||
* "remove": ["variant_789"]
|
||||
* }'
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminBatchImageVariantResponse"
|
||||
* "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"
|
||||
* x-workflow: batchImageVariantsWorkflow
|
||||
* x-events: []
|
||||
* x-since: 2.11.2
|
||||
*
|
||||
*/
|
||||
|
||||
+86
@@ -0,0 +1,86 @@
|
||||
/**
|
||||
* @oas [post] /admin/products/{id}/variants/{variant_id}/images/batch
|
||||
* operationId: PostProductsIdVariantsVariant_idImagesBatch
|
||||
* summary: Manage Images of Product Variant
|
||||
* description: Manage the association between product images and a product variant. You can add or remove associations between images and the variant.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: id
|
||||
* in: path
|
||||
* description: The product's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: variant_id
|
||||
* in: path
|
||||
* description: The product variant's ID.
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminBatchVariantImagesRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
* source: |-
|
||||
* import Medusa from "@medusajs/js-sdk"
|
||||
*
|
||||
* export const sdk = new Medusa({
|
||||
* baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
|
||||
* debug: import.meta.env.DEV,
|
||||
* auth: {
|
||||
* type: "session",
|
||||
* },
|
||||
* })
|
||||
*
|
||||
* sdk.admin.product.batchVariantImages("prod_123", "variant_123", {
|
||||
* add: ["img_123", "img_456"],
|
||||
* remove: ["img_789"]
|
||||
* })
|
||||
* .then(({ added, removed }) => {
|
||||
* console.log(added, removed)
|
||||
* })
|
||||
* - lang: Shell
|
||||
* label: cURL
|
||||
* source: |-
|
||||
* curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/images/batch' \
|
||||
* -H 'Authorization: Bearer {access_token}' \
|
||||
* -H 'Content-Type: application/json' \
|
||||
* --data-raw '{
|
||||
* "add": ["img_123", "img_456"],
|
||||
* "remove": ["img_789"]
|
||||
* }'
|
||||
* tags:
|
||||
* - Products
|
||||
* responses:
|
||||
* "200":
|
||||
* description: OK
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminBatchVariantImagesResponse"
|
||||
* "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"
|
||||
* x-workflow: batchVariantImagesWorkflow
|
||||
* x-events: []
|
||||
* x-since: 2.11.2
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -31,8 +31,8 @@
|
||||
* description: The associations to create between a product variant and an inventory item.
|
||||
* required:
|
||||
* - variant_id
|
||||
* - inventory_item_id
|
||||
* - required_quantity
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* required_quantity:
|
||||
* type: number
|
||||
@@ -55,8 +55,8 @@
|
||||
* description: Update a product variant's association with an inventory item.
|
||||
* required:
|
||||
* - variant_id
|
||||
* - inventory_item_id
|
||||
* - required_quantity
|
||||
* - inventory_item_id
|
||||
* properties:
|
||||
* required_quantity:
|
||||
* type: number
|
||||
|
||||
@@ -23,6 +23,610 @@
|
||||
* fields. without prefix it will replace the entire default fields.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - name: tags
|
||||
* in: query
|
||||
* description: Filter products by their tags.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter products by their tags.
|
||||
* properties:
|
||||
* id:
|
||||
* type: array
|
||||
* description: Filter by tag IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: A tag ID.
|
||||
* - name: variants
|
||||
* in: query
|
||||
* description: Filter the products' variants.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter the products' variants.
|
||||
* properties:
|
||||
* options:
|
||||
* type: object
|
||||
* description: Filter the variants by their options.
|
||||
* properties:
|
||||
* value:
|
||||
* type: string
|
||||
* title: value
|
||||
* description: The option's value.
|
||||
* option_id:
|
||||
* type: string
|
||||
* title: option_id
|
||||
* description: The option's ID.
|
||||
* option:
|
||||
* type: object
|
||||
* description: The option's details.
|
||||
* - name: title
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: title
|
||||
* description: Filter products by their title.
|
||||
* - type: array
|
||||
* description: Filter products by multiple titles.
|
||||
* items:
|
||||
* type: string
|
||||
* title: title
|
||||
* description: A product title.
|
||||
* - name: status
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: status
|
||||
* description: Filter products by their status.
|
||||
* enum:
|
||||
* - draft
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* - type: array
|
||||
* description: Filter products by multiple statuses.
|
||||
* items:
|
||||
* type: string
|
||||
* description: A product status.
|
||||
* enum:
|
||||
* - draft
|
||||
* - proposed
|
||||
* - published
|
||||
* - rejected
|
||||
* - name: id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: id
|
||||
* description: Filter products by their ID.
|
||||
* - type: array
|
||||
* description: Filter products by multiple IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: A product ID.
|
||||
* - name: sales_channel_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: sales_channel_id
|
||||
* description: Filter products by their sales channel ID.
|
||||
* - type: array
|
||||
* description: Filter products by multiple sales channel IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: sales_channel_id
|
||||
* description: A sales channel ID.
|
||||
* - name: created_at
|
||||
* in: query
|
||||
* description: Filter by a product's creation date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a product's creation date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: updated_at
|
||||
* in: query
|
||||
* description: Filter by a product's update date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a product's update date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - name: handle
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: handle
|
||||
* description: Filter products by their handle.
|
||||
* - type: array
|
||||
* description: Filter products by multiple handles.
|
||||
* items:
|
||||
* type: string
|
||||
* title: handle
|
||||
* description: A product handle.
|
||||
* - name: is_giftcard
|
||||
* in: query
|
||||
* description: Filter products by whether they are gift cards.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: is_giftcard
|
||||
* description: Whether the product is a gift card.
|
||||
* - name: collection_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: collection_id
|
||||
* description: Filter products by their collection ID.
|
||||
* - type: array
|
||||
* description: Filter products by multiple collection IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: collection_id
|
||||
* description: A collection ID.
|
||||
* - name: type_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: type_id
|
||||
* description: Filter products by their type ID.
|
||||
* - type: array
|
||||
* description: Filter products by multiple type IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: type_id
|
||||
* description: The type ID's details.
|
||||
* - name: deleted_at
|
||||
* in: query
|
||||
* description: Filter by a product's deletion date.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: object
|
||||
* description: Filter by a product's deletion date.
|
||||
* properties:
|
||||
* $and:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* $or:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* $eq:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* - type: array
|
||||
* description: Filter by an exact match.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $eq
|
||||
* description: Filter by an exact match.
|
||||
* $ne:
|
||||
* type: string
|
||||
* title: $ne
|
||||
* description: Filter by values not equal to this parameter.
|
||||
* $in:
|
||||
* type: array
|
||||
* description: Filter by values in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $in
|
||||
* description: Filter by values in this array.
|
||||
* $nin:
|
||||
* type: array
|
||||
* description: Filter by values not in this array.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $nin
|
||||
* description: Filter by values not in this array.
|
||||
* $not:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: object
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* - type: array
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $not
|
||||
* description: Filter by values not matching the conditions in this parameter.
|
||||
* $gt:
|
||||
* type: string
|
||||
* title: $gt
|
||||
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||
* $gte:
|
||||
* type: string
|
||||
* title: $gte
|
||||
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $lt:
|
||||
* type: string
|
||||
* title: $lt
|
||||
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||
* $lte:
|
||||
* type: string
|
||||
* title: $lte
|
||||
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||
* $like:
|
||||
* type: string
|
||||
* title: $like
|
||||
* description: Apply a `like` filter. Useful for strings only.
|
||||
* $re:
|
||||
* type: string
|
||||
* title: $re
|
||||
* description: Apply a regex filter. Useful for strings only.
|
||||
* $ilike:
|
||||
* type: string
|
||||
* title: $ilike
|
||||
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||
* $fulltext:
|
||||
* type: string
|
||||
* title: $fulltext
|
||||
* description: Filter to apply on full-text properties.
|
||||
* $overlap:
|
||||
* type: array
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $overlap
|
||||
* description: Filter arrays that have overlapping values with this parameter.
|
||||
* $contains:
|
||||
* type: array
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contains
|
||||
* description: Filter arrays that contain some of the values of this parameter.
|
||||
* $contained:
|
||||
* type: array
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* items:
|
||||
* type: string
|
||||
* title: $contained
|
||||
* description: Filter arrays that contain all values of this parameter.
|
||||
* $exists:
|
||||
* type: boolean
|
||||
* title: $exists
|
||||
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - name: q
|
||||
* in: query
|
||||
* description: The product's q.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: q
|
||||
* description: The product's q.
|
||||
* - name: category_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: category_id
|
||||
* description: Filter products by their category ID.
|
||||
* - type: array
|
||||
* description: Filter products by their category IDs.
|
||||
* items:
|
||||
* type: string
|
||||
* title: category_id
|
||||
* description: A category ID.
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - name: with_deleted
|
||||
* in: query
|
||||
* description: The product's with deleted.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: The product's with deleted.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* - name: price_list_id
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: price_list_id
|
||||
* description: Filter products by the ID of a price list they belong to.
|
||||
* - type: array
|
||||
* description: Filter products by the IDs of price lists they belong to.
|
||||
* items:
|
||||
* type: string
|
||||
* title: price_list_id
|
||||
* description: A price list ID.
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+27
-8
@@ -12,18 +12,37 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* - name: promotion_type
|
||||
* 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.
|
||||
* description: The promotion's type.
|
||||
* 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* description: The promotion's type.
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method type.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* - name: application_method_target_type
|
||||
* in: query
|
||||
* description: The promotion's application method target type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method target type.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+27
-8
@@ -12,18 +12,37 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* - name: promotion_type
|
||||
* 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.
|
||||
* description: The promotion's type.
|
||||
* 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* description: The promotion's type.
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method type.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* - name: application_method_target_type
|
||||
* in: query
|
||||
* description: The promotion's application method target type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method target type.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
+27
-8
@@ -12,18 +12,37 @@
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - name: fields
|
||||
* - name: promotion_type
|
||||
* 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.
|
||||
* description: The promotion's type.
|
||||
* 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.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* description: The promotion's type.
|
||||
* enum:
|
||||
* - standard
|
||||
* - buyget
|
||||
* - name: application_method_type
|
||||
* in: query
|
||||
* description: The promotion's application method type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method type.
|
||||
* enum:
|
||||
* - fixed
|
||||
* - percentage
|
||||
* - name: application_method_target_type
|
||||
* in: query
|
||||
* description: The promotion's application method target type.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* description: The promotion's application method target type.
|
||||
* enum:
|
||||
* - items
|
||||
* - shipping_methods
|
||||
* - order
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminUpdatePaymentRefundReason"
|
||||
* $ref: "#/components/schemas/AdminUpdateRefundReason"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminInitiateReturnRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsReturnReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateReturnRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminDismissItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsReceiveItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminReceiveItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReceiveReturnsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminInitiateReceiveReturn"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsConfirmRequestReqSchema"
|
||||
* $ref: "#/components/schemas/AdminConfirmReceiveReturn"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsRequestItemsReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddReturnItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsRequestItemsActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateReturnItems"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsConfirmRequestReqSchema"
|
||||
* $ref: "#/components/schemas/AdminConfirmReturnRequest"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -32,7 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsShippingReqSchema"
|
||||
* $ref: "#/components/schemas/AdminAddReturnShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -41,7 +41,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminPostReturnsShippingActionReqSchema"
|
||||
* $ref: "#/components/schemas/AdminUpdateReturnShipping"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The products to add or remove from the channel.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The products to add to the sales channel.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A product's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The products to remove from the sales channel.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A product's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
@@ -31,7 +31,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/AdminUpdateShippingOptionType"
|
||||
* $ref: "#/components/schemas/AdminUpdateShippingOption"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The fulfillment providers to add or remove from the stock location.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The fulfillment providers to add to the stock location.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A fulfillment provider's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The fulfillment providers to remove from the stock location.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A fulfillment provider's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-17
@@ -32,23 +32,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* type: object
|
||||
* description: The sales channels to add or remove.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The sales channels to add.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: A sales channel's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The sales channels to remove.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: A sales channel's ID.
|
||||
* $ref: "#/components/schemas/AdminBatchLink"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+45
-47
@@ -17,48 +17,6 @@
|
||||
* type: string
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||
* - 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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom
|
||||
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
|
||||
* 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. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom
|
||||
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
|
||||
* externalDocs:
|
||||
* url: "#select-fields-and-relations"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* - name: city
|
||||
* in: query
|
||||
* description: Filter by the address's city.
|
||||
@@ -112,14 +70,54 @@
|
||||
* type: string
|
||||
* title: q
|
||||
* description: Search term to filter the address's searchable properties.
|
||||
* - name: with_deleted
|
||||
* - name: company
|
||||
* in: query
|
||||
* description: Whether to include deleted records in the result.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: boolean
|
||||
* title: with_deleted
|
||||
* description: Whether to include deleted records in the result.
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: company
|
||||
* description: Filter addresses by company.
|
||||
* - type: array
|
||||
* description: Filter addresses by companies.
|
||||
* items:
|
||||
* type: string
|
||||
* title: company
|
||||
* description: A company.
|
||||
* - name: province
|
||||
* in: query
|
||||
* required: false
|
||||
* schema:
|
||||
* oneOf:
|
||||
* - type: string
|
||||
* title: province
|
||||
* description: Filter addresses by province.
|
||||
* - type: array
|
||||
* description: Filter addresses by provinces.
|
||||
* items:
|
||||
* type: string
|
||||
* title: province
|
||||
* description: A province.
|
||||
* - name: $and
|
||||
* in: query
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $and
|
||||
* - name: $or
|
||||
* in: query
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: array
|
||||
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||
* items:
|
||||
* type: object
|
||||
* title: $or
|
||||
* security:
|
||||
* - cookie_auth: []
|
||||
* - jwt_token: []
|
||||
|
||||
@@ -73,36 +73,6 @@
|
||||
* type: string
|
||||
* title: cart_id
|
||||
* description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties.
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* - 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 `-`.
|
||||
* externalDocs:
|
||||
* url: "#pagination"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+1
-1
@@ -38,7 +38,7 @@
|
||||
* content:
|
||||
* application/json:
|
||||
* schema:
|
||||
* $ref: "#/components/schemas/StoreDeclineOrderTransferRequest"
|
||||
* $ref: "#/components/schemas/StoreDeclineOrderTransfer"
|
||||
* x-codeSamples:
|
||||
* - lang: JavaScript
|
||||
* label: JS SDK
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostClaimItemsReqSchema
|
||||
* @schema AdminAddClaimItems
|
||||
* type: object
|
||||
* description: The details of the order items to add to the claim.
|
||||
* x-schemaName: AdminPostClaimItemsReqSchema
|
||||
* x-schemaName: AdminAddClaimItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
@@ -0,0 +1,43 @@
|
||||
/**
|
||||
* @schema AdminAddClaimOutboundItems
|
||||
* type: object
|
||||
* description: The details of the outbound items to add to the claim.
|
||||
* x-schemaName: AdminAddClaimOutboundItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The outbound item's details.
|
||||
* items:
|
||||
* type: object
|
||||
* description: An item's details.
|
||||
* required:
|
||||
* - id
|
||||
* - quantity
|
||||
* properties:
|
||||
* quantity:
|
||||
* type: number
|
||||
* title: quantity
|
||||
* description: The quantity to send to the customer.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The item's ID.
|
||||
* reason:
|
||||
* type: string
|
||||
* description: The item's reason.
|
||||
* enum:
|
||||
* - missing_item
|
||||
* - wrong_item
|
||||
* - production_failure
|
||||
* - other
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The item's description.
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesReturnRequestItemsReqSchema
|
||||
* @schema AdminAddExchangeInboundItems
|
||||
* type: object
|
||||
* description: The details of the inbound (return) items.
|
||||
* x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
|
||||
* x-schemaName: AdminAddExchangeInboundItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostExchangesAddItemsReqSchema
|
||||
* @schema AdminAddExchangeOutboundItems
|
||||
* type: object
|
||||
* description: The details of outbound items.
|
||||
* x-schemaName: AdminPostExchangesAddItemsReqSchema
|
||||
* x-schemaName: AdminAddExchangeOutboundItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
@@ -0,0 +1,34 @@
|
||||
/**
|
||||
* @schema AdminAddReturnItem
|
||||
* type: object
|
||||
* description: An item's details.
|
||||
* 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: A note viewed only by admin users.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The item's metadata, can hold custom key-value pairs.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
* description: Learn how to manage metadata
|
||||
* x-schemaName: AdminAddReturnItem
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* @schema AdminAddReturnItems
|
||||
* type: object
|
||||
* description: The items' details.
|
||||
* x-schemaName: AdminAddReturnItems
|
||||
* properties:
|
||||
* items:
|
||||
* type: array
|
||||
* description: The items' details.
|
||||
* items:
|
||||
* $ref: "#/components/schemas/AdminAddReturnItem"
|
||||
* required:
|
||||
* - items
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,33 @@
|
||||
/**
|
||||
* @schema AdminAddReturnShipping
|
||||
* type: object
|
||||
* description: The shipping method's details.
|
||||
* x-schemaName: AdminAddReturnShipping
|
||||
* required:
|
||||
* - shipping_option_id
|
||||
* properties:
|
||||
* shipping_option_id:
|
||||
* type: string
|
||||
* title: shipping_option_id
|
||||
* description: The ID of the associated shipping option.
|
||||
* custom_amount:
|
||||
* type: number
|
||||
* title: custom_amount
|
||||
* description: Set the price of the shipping method.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The shipping method's description.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note viewed only by admin users.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The exchange's metadata, can hold custom key-value pairs.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
* description: Learn how to manage metadata
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* @schema AdminCreateInventoryLocationLevel
|
||||
* @schema AdminBatchCreateInventoryItemLocationLevels
|
||||
* type: object
|
||||
* description: The inventory level's details.
|
||||
* required:
|
||||
@@ -17,7 +17,7 @@
|
||||
* type: number
|
||||
* title: incoming_quantity
|
||||
* description: The inventory level's incoming quantity.
|
||||
* x-schemaName: AdminCreateInventoryLocationLevel
|
||||
* x-schemaName: AdminBatchCreateInventoryItemLocationLevels
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminBatchImageVariantRequest
|
||||
* type: object
|
||||
* description: Details of the associations between variants and a product image to manage.
|
||||
* x-schemaName: AdminBatchImageVariantRequest
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The IDs of product variants to add the image to.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: The ID of the variant to add.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The IDs of product variants to remove the image from.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: The ID of the variant to remove.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
/**
|
||||
* @schema AdminBatchImageVariantResponse
|
||||
* type: object
|
||||
* description: Result of managing the associations between variants and a product image.
|
||||
* x-schemaName: AdminBatchImageVariantResponse
|
||||
* required:
|
||||
* - added
|
||||
* - removed
|
||||
* properties:
|
||||
* added:
|
||||
* type: array
|
||||
* description: The IDs of product variants added the image to.
|
||||
* items:
|
||||
* type: string
|
||||
* title: added
|
||||
* description: The ID of the variant added.
|
||||
* removed:
|
||||
* type: array
|
||||
* description: The IDs of product variants removed the image from.
|
||||
* items:
|
||||
* type: string
|
||||
* title: removed
|
||||
* description: The ID of the variant removed.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminBatchLink
|
||||
* type: object
|
||||
* description: A batch operation to manage the associations between two entities.
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The IDs of an entity to add to the other.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: The entity's ID.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The IDs of an entity to remove from the other.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: The entity's ID.
|
||||
* x-schemaName: AdminBatchLink
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -37,6 +37,10 @@
|
||||
* type: string
|
||||
* title: url
|
||||
* description: The image's URL.
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The image's ID.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
|
||||
@@ -86,6 +86,10 @@
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The update's ID.
|
||||
* thumbnail:
|
||||
* type: string
|
||||
* title: thumbnail
|
||||
* description: The variant's thumbnail.
|
||||
* required:
|
||||
* - id
|
||||
*
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminBatchVariantImagesRequest
|
||||
* type: object
|
||||
* description: Details of the associations between images and a product variant to manage.
|
||||
* x-schemaName: AdminBatchVariantImagesRequest
|
||||
* properties:
|
||||
* add:
|
||||
* type: array
|
||||
* description: The IDs of product images to add to the variant.
|
||||
* items:
|
||||
* type: string
|
||||
* title: add
|
||||
* description: The ID of the image to add.
|
||||
* remove:
|
||||
* type: array
|
||||
* description: The IDs of product images to remove from the variant.
|
||||
* items:
|
||||
* type: string
|
||||
* title: remove
|
||||
* description: The ID of the image to remove.
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
/**
|
||||
* @schema AdminBatchVariantImagesResponse
|
||||
* type: object
|
||||
* description: Result of managing the associations between images and a product variant.
|
||||
* x-schemaName: AdminBatchVariantImagesResponse
|
||||
* required:
|
||||
* - added
|
||||
* - removed
|
||||
* properties:
|
||||
* added:
|
||||
* type: array
|
||||
* description: The IDs of product images added to the variant.
|
||||
* items:
|
||||
* type: string
|
||||
* title: added
|
||||
* description: The ID of the image added.
|
||||
* removed:
|
||||
* type: array
|
||||
* description: The IDs of product images removed from the variant.
|
||||
* items:
|
||||
* type: string
|
||||
* title: removed
|
||||
* description: The ID of the image removed.
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* @schema AdminCreatePaymentCapture
|
||||
* @schema AdminCapturePayment
|
||||
* type: object
|
||||
* description: The payment's details.
|
||||
* properties:
|
||||
@@ -7,7 +7,7 @@
|
||||
* type: number
|
||||
* title: amount
|
||||
* description: The amount to capture.
|
||||
* x-schemaName: AdminCreatePaymentCapture
|
||||
* x-schemaName: AdminCapturePayment
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostClaimsShippingReqSchema
|
||||
* @schema AdminClaimAddOutboundShipping
|
||||
* type: object
|
||||
* description: The details of the shipping method used to ship outbound items.
|
||||
* x-schemaName: AdminPostClaimsShippingReqSchema
|
||||
* x-schemaName: AdminClaimAddOutboundShipping
|
||||
* required:
|
||||
* - shipping_option_id
|
||||
* properties:
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostClaimsShippingActionReqSchema
|
||||
* @schema AdminClaimUpdateInboundShipping
|
||||
* type: object
|
||||
* description: The details to update in the shipping method.
|
||||
* x-schemaName: AdminPostClaimsShippingActionReqSchema
|
||||
* x-schemaName: AdminClaimUpdateInboundShipping
|
||||
* properties:
|
||||
* custom_amount:
|
||||
* type: number
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* @schema AdminClaimUpdateOutboundShipping
|
||||
* type: object
|
||||
* description: The details to update in the shipping method.
|
||||
* x-schemaName: AdminClaimUpdateOutboundShipping
|
||||
* properties:
|
||||
* custom_amount:
|
||||
* type: number
|
||||
* title: custom_amount
|
||||
* description: The shipping method's custom amount.
|
||||
* internal_note:
|
||||
* type: string
|
||||
* title: internal_note
|
||||
* description: A note only viewed by admin users.
|
||||
* metadata:
|
||||
* type: object
|
||||
* description: The claim's metadata, can hold custom key-value pairs.
|
||||
* externalDocs:
|
||||
* url: https://docs.medusajs.com/api/admin#manage-metadata
|
||||
* description: Learn how to manage metadata
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostReturnsConfirmRequestReqSchema
|
||||
* @schema AdminConfirmReceiveReturn
|
||||
* type: object
|
||||
* description: The confirmation's details.
|
||||
* x-schemaName: AdminPostReturnsConfirmRequestReqSchema
|
||||
* x-schemaName: AdminConfirmReceiveReturn
|
||||
* properties:
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema AdminConfirmReturnRequest
|
||||
* type: object
|
||||
* description: The confirmation's details.
|
||||
* x-schemaName: AdminConfirmReturnRequest
|
||||
* properties:
|
||||
* no_notification:
|
||||
* type: boolean
|
||||
* title: no_notification
|
||||
* description: Whether to send the customer a notification about the confirmation.
|
||||
*
|
||||
*/
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* @schema AdminPostOrderClaimsReqSchema
|
||||
* @schema AdminCreateClaim
|
||||
* type: object
|
||||
* description: The claim's details.
|
||||
* x-schemaName: AdminPostOrderClaimsReqSchema
|
||||
* x-schemaName: AdminCreateClaim
|
||||
* required:
|
||||
* - type
|
||||
* - order_id
|
||||
Loaded 100 of 403 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user