asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (v2) (#8929)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-09-02 07:45:24 +00:00
committed by GitHub
parent 2c034774f0
commit d6dcda5b8f
355 changed files with 66808 additions and 5101 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
-3
View File
@@ -50,9 +50,6 @@
* type: boolean
* title: deleted
* description: Whether the API key was deleted.
* parent:
* type: object
* description: The API key's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
-3
View File
@@ -50,9 +50,6 @@
* type: boolean
* title: deleted
* description: Whether the campaign was deleted.
* parent:
* type: object
* description: The campaign's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: The customer group's deleted.
* parent:
* type: object
* description: The customer group's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts
-3
View File
@@ -48,9 +48,6 @@
* type: boolean
* title: deleted
* description: The customer's deleted.
* parent:
* type: object
* description: The customer's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
+25 -21
View File
@@ -75,28 +75,32 @@
* content:
* application/json:
* schema:
* type: object
* allOf:
* - type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* deleted:
* type: boolean
* title: deleted
* description: Whether the Customer was deleted.
* - type: object
* description: SUMMARY
* properties:
* parent:
* $ref: "#/components/schemas/AdminCustomer"
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The customer's ID.
* object:
* type: string
* title: object
* description: The customer's object.
* deleted:
* type: boolean
* title: deleted
* description: The customer's deleted.
* parent:
* type: object
* description: The customer's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts
+1 -23
View File
@@ -29,29 +29,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The exchange's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: exchange
* deleted:
* type: boolean
* title: deleted
* description: Whether the exchange was deleted.
* parent:
* type: object
* description: The exchange's parent.
* $ref: "#/components/schemas/AdminExchangeDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+1 -23
View File
@@ -34,29 +34,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The service zone's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: service_zone
* deleted:
* type: boolean
* title: deleted
* description: Whether the service zone was deleted.
* parent:
* type: object
* description: The fulfillment set that the service zone belongs to.
* $ref: "#/components/schemas/AdminServiceZoneDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the inventory item was deleted.
* parent:
* type: object
* description: The inventory item's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
+25 -22
View File
@@ -79,29 +79,32 @@
* content:
* application/json:
* schema:
* type: object
* allOf:
* - type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The inventory item's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* deleted:
* type: boolean
* title: deleted
* description: Whether the Inventory Item was deleted.
* - type: object
* description: SUMMARY
* properties:
* parent:
* $ref: "#/components/schemas/AdminInventoryItem"
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The inventory level's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: inventory-level
* deleted:
* type: boolean
* title: deleted
* description: Whether the inventory level was deleted.
* parent:
* type: object
* description: The inventory item of the level.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts
-3
View File
@@ -43,9 +43,6 @@
* type: boolean
* title: deleted
* description: Whether the invite was deleted.
* parent:
* type: object
* description: The invite's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_order-edits_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the order edit was deleted.
* parent:
* type: object
* description: The order edit's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_payment-collections_[id].ts
+1 -23
View File
@@ -29,29 +29,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The payment collection's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: payment-collection
* deleted:
* type: boolean
* title: deleted
* description: Whether the payment collection was deleted.
* parent:
* type: object
* description: The payment collection's parent.
* $ref: "#/components/schemas/AdminDeletePaymentCollectionResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the promotion was deleted.
* parent:
* type: object
* description: The promotion's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_refund-reasons_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the refund reason was deleted.
* parent:
* type: object
* description: The refund reason's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the region was deleted.
* parent:
* type: object
* description: The region's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the reservation was deleted.
* parent:
* type: object
* description: The reservation's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts
+1 -23
View File
@@ -29,29 +29,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The return reason's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: return_reason
* deleted:
* type: boolean
* title: deleted
* description: Whether the return reason was deleted.
* parent:
* type: object
* description: The return reason's parent.
* $ref: "#/components/schemas/AdminReturnReasonDeleteResponse"
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive.ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the return was deleted.
* parent:
* type: object
* description: The return's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request.ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the return was deleted.
* parent:
* type: object
* description: The return's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts
+2 -4
View File
@@ -3,12 +3,10 @@
* operationId: DeleteReturnsIdShippingMethodAction_id
* summary: Remove Shipping Method from Return
* x-sidebar-summary: Remove Shipping Method
* description: >
* description: |
* Remove a shipping method of the return by the ID of the item's `SHIPPING_ADD` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
+25 -22
View File
@@ -78,29 +78,32 @@
* content:
* application/json:
* schema:
* type: object
* allOf:
* - type: object
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The tax rate's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* deleted:
* type: boolean
* title: deleted
* description: Whether the Tax Rate was deleted.
* - type: object
* description: SUMMARY
* properties:
* parent:
* $ref: "#/components/schemas/AdminTaxRate"
* description: SUMMARY
* required:
* - id
* - object
* - deleted
* properties:
* id:
* type: string
* title: id
* description: The tax rate's ID.
* object:
* type: string
* title: object
* description: The name of the deleted object.
* default: "tax_rate_rule"
* deleted:
* type: boolean
* title: deleted
* description: Whether the tax rate rule was deleted.
* parent:
* type: object
* description: The parent tax rate.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts
-3
View File
@@ -49,9 +49,6 @@
* type: boolean
* title: deleted
* description: Whether the file was deleted.
* parent:
* type: object
* description: The upload's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":
www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/api-keys
* operationId: GetApiKeys
* summary: List API Keys
* description: Retrieve a list of API keys. The API keys can be filtered by fields
* such as `id`. The API keys can also be sorted or paginated.
* description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated.
* x-authenticated: true
* parameters:
* - name: expand
www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/api-keys/{id}
* operationId: GetApiKeysId
* summary: Get API Key
* description: Retrieve an API key by its ID. You can expand the API key's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve an API key by its ID. You can expand the API key's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts
-48
View File
@@ -47,54 +47,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: q
* in: query
* description: Search term to filter the campaign's searchable properties.
* required: false
* schema:
* type: string
* title: q
* description: Search term to filter the campaign's searchable properties.
* - name: campaign_identifier
* in: query
* description: Filter the campaign by its identifier.
* required: false
* schema:
* type: string
* title: campaign_identifier
* description: Filter the campaign by its identifier.
* - name: budget
* in: query
* description: Filter the campaign by its budget.
* required: false
* schema:
* type: object
* description: Filter the campaign by its budget.
* properties:
* currency_code:
* type: string
* title: currency_code
* description: Filter the campaign by its budget's currency code.
* - 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: []
www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/campaigns/{id}
* operationId: GetCampaignsId
* summary: Get a Campaign
* description: Retrieve a campaign by its ID. You can expand the campaign's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_claims.ts
+763
View File
@@ -47,6 +47,769 @@
* 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: deleted_at
* in: query
* description: The claim's deleted at.
* required: false
* schema:
* type: object
* description: The claim's deleted at.
* 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.
* 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`).
* - 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: q
* in: query
* description: The claim's q.
* required: false
* schema:
* type: string
* title: q
* description: The claim's q.
* - name: id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: id
* description: The claim's ID.
* - type: array
* description: The claim's ID.
* items:
* type: string
* title: id
* description: The id's ID.
* - name: order_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: order_id
* description: The claim's order id.
* - type: array
* description: The claim's order id.
* items:
* type: string
* title: order_id
* description: The order id's details.
* - name: status
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: status
* description: The claim's status.
* - type: array
* description: The claim's status.
* items:
* type: string
* title: status
* description: The status's details.
* - name: created_at
* in: query
* description: The claim's created at.
* required: false
* schema:
* type: object
* description: The claim's created at.
* 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.
* 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`).
* - 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: The claim's updated at.
* required: false
* schema:
* type: object
* description: The claim's updated at.
* 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.
* 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`).
* - 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: $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: []
www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/claims/{id}
* operationId: GetClaimsId
* summary: Get a Claim
* description: Retrieve a claim by its ID. You can expand the claim's relations or
* select the fields that should be returned using the query parameters.
* description: Retrieve a claim by its ID. You can expand the claim's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/collections/{id}
* operationId: GetCollectionsId
* summary: Get a Collection
* description: Retrieve a collection by its ID. You can expand the collection's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve a collection by its ID. You can expand the collection's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: id
www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts
+1 -2
View File
@@ -2,8 +2,7 @@
* @oas [get] /admin/currencies/{code}
* operationId: GetCurrenciesCode
* summary: Get a Currency
* description: Retrieve a currency by its code. You can expand the currency's
* relations or select the fields that should be returned using the query parameters.
* description: Retrieve a currency by its code. You can expand the currency's relations or select the fields that should be returned using the query parameters.
* x-authenticated: true
* parameters:
* - name: code
www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts
+4 -4
View File
@@ -28,16 +28,16 @@
* 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.
* 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.
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
* without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts
+14
View File
@@ -518,6 +518,20 @@
* items:
* type: object
* title: $or
* - name: name
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: name
* description: The product category's name.
* - type: array
* description: The product category's name.
* items:
* type: string
* title: name
* description: The name's details.
* security:
* - api_token: []
* - cookie_auth: []
www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts
+1 -93
View File
@@ -55,99 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - sku
* - hs_code
* - weight
* - length
* - height
* - width
* - origin_country
* - mid_code
* - material
* - title
* - description
* - thumbnail
* - metadata
* properties:
* sku:
* type: string
* title: sku
* description: The inventory item's sku.
* hs_code:
* type: string
* title: hs_code
* description: The inventory item's hs code.
* weight:
* type: number
* title: weight
* description: The inventory item's weight.
* length:
* type: number
* title: length
* description: The inventory item's length.
* height:
* type: number
* title: height
* description: The inventory item's height.
* width:
* type: number
* title: width
* description: The inventory item's width.
* origin_country:
* type: string
* title: origin_country
* description: The inventory item's origin country.
* mid_code:
* type: string
* title: mid_code
* description: The inventory item's mid code.
* material:
* type: string
* title: material
* description: The inventory item's material.
* title:
* type: string
* title: title
* description: The inventory item's title.
* description:
* type: string
* title: description
* description: The inventory item's description.
* requires_shipping:
* type: boolean
* title: requires_shipping
* description: The inventory item's requires shipping.
* thumbnail:
* type: string
* title: thumbnail
* description: The inventory item's thumbnail.
* metadata:
* type: object
* description: The inventory item's metadata.
* location_levels:
* type: array
* description: The inventory item's location levels.
* items:
* type: object
* description: The location level's location levels.
* required:
* - location_id
* properties:
* location_id:
* type: string
* title: location_id
* description: The location level's location id.
* stocked_quantity:
* type: number
* title: stocked_quantity
* description: The location level's stocked quantity.
* incoming_quantity:
* type: number
* title: incoming_quantity
* description: The location level's incoming quantity.
* $ref: "#/components/schemas/AdminCreateInventoryItem"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_invites.ts
+3
View File
@@ -61,6 +61,9 @@
* title: email
* description: The invite's email.
* format: email
* metadata:
* type: object
* description: The invite's metadata.
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts
+1 -38
View File
@@ -55,44 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - parent_category_id
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The product category's name.
* description:
* type: string
* title: description
* description: The product category's description.
* handle:
* type: string
* title: handle
* description: The product category's handle.
* is_internal:
* type: boolean
* title: is_internal
* description: The product category's is internal.
* is_active:
* type: boolean
* title: is_active
* description: The product category's is active.
* parent_category_id:
* type: string
* title: parent_category_id
* description: The product category's parent category id.
* metadata:
* type: object
* description: The product category's metadata.
* rank:
* type: number
* title: rank
* description: The product category's rank.
* $ref: "#/components/schemas/AdminCreateProductCategory"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts
+1 -13
View File
@@ -55,19 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - value
* - metadata
* properties:
* value:
* type: string
* title: value
* description: The product tag's value.
* metadata:
* type: object
* description: The product tag's metadata.
* $ref: "#/components/schemas/AdminCreateProductTag"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts
+1 -13
View File
@@ -55,19 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - value
* - metadata
* properties:
* value:
* type: string
* title: value
* description: The product type's value.
* metadata:
* type: object
* description: The product type's metadata.
* $ref: "#/components/schemas/AdminCreateProduct"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts
+1 -14
View File
@@ -55,20 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - label
* - description
* properties:
* label:
* type: string
* title: label
* description: The refund reason's label.
* description:
* type: string
* title: description
* description: The refund reason's description.
* $ref: "#/components/schemas/AdminCreateRefundReason"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_regions.ts
+1 -40
View File
@@ -55,46 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - currency_code
* - metadata
* properties:
* name:
* type: string
* title: name
* description: The region's name.
* currency_code:
* type: string
* title: currency_code
* description: The region's currency code.
* countries:
* type: array
* description: The region's countries.
* items:
* type: string
* title: countries
* description: The country's countries.
* automatic_taxes:
* type: boolean
* title: automatic_taxes
* description: The region's automatic taxes.
* payment_providers:
* type: array
* description: The region's payment providers.
* items:
* type: string
* title: payment_providers
* description: The payment provider's payment providers.
* metadata:
* type: object
* description: The region's metadata.
* is_tax_inclusive:
* type: boolean
* title: is_tax_inclusive
* description: The region's is tax inclusive.
* $ref: "#/components/schemas/AdminCreateRegion"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts
+1 -33
View File
@@ -55,39 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - line_item_id
* - location_id
* - inventory_item_id
* - quantity
* - description
* - metadata
* properties:
* line_item_id:
* type: string
* title: line_item_id
* description: The reservation's line item id.
* location_id:
* type: string
* title: location_id
* description: The reservation's location id.
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* quantity:
* type: number
* title: quantity
* description: The reservation's quantity.
* description:
* type: string
* title: description
* description: The reservation's description.
* metadata:
* type: object
* description: The reservation's metadata.
* $ref: "#/components/schemas/AdminCreateReservation"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts
+1 -125
View File
@@ -55,131 +55,7 @@
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - name
* - service_zone_id
* - shipping_profile_id
* - price_type
* - provider_id
* - type
* - prices
* properties:
* name:
* type: string
* title: name
* description: The shipping option's name.
* service_zone_id:
* type: string
* title: service_zone_id
* description: The shipping option's service zone id.
* shipping_profile_id:
* type: string
* title: shipping_profile_id
* description: The shipping option's shipping profile id.
* data:
* type: object
* description: The shipping option's data.
* price_type:
* type: string
* enum:
* - calculated
* - flat
* provider_id:
* type: string
* title: provider_id
* description: The shipping option's provider id.
* type:
* type: object
* description: The shipping option's type.
* required:
* - label
* - description
* - code
* properties:
* label:
* type: string
* title: label
* description: The type's label.
* description:
* type: string
* title: description
* description: The type's description.
* code:
* type: string
* title: code
* description: The type's code.
* prices:
* type: array
* description: The shipping option's prices.
* items:
* oneOf:
* - type: object
* description: The price's prices.
* required:
* - currency_code
* - amount
* properties:
* currency_code:
* type: string
* title: currency_code
* description: The price's currency code.
* amount:
* type: number
* title: amount
* description: The price's amount.
* - type: object
* description: The price's prices.
* required:
* - region_id
* - amount
* properties:
* region_id:
* type: string
* title: region_id
* description: The price's region id.
* amount:
* type: number
* title: amount
* description: The price's amount.
* rules:
* type: array
* description: The shipping option's rules.
* items:
* type: object
* description: The rule's rules.
* required:
* - operator
* - attribute
* - value
* properties:
* operator:
* type: string
* enum:
* - in
* - eq
* - ne
* - gt
* - gte
* - lt
* - lte
* - nin
* attribute:
* type: string
* title: attribute
* description: The rule's attribute.
* value:
* oneOf:
* - type: string
* title: value
* description: The rule's value.
* - type: array
* description: The rule's value.
* items:
* type: string
* title: value
* description: The value's details.
* $ref: "#/components/schemas/AdminCreateShippingOption"
* x-codeSamples:
* - lang: Shell
* label: cURL
www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts
+28 -1
View File
@@ -13,7 +13,34 @@
* content:
* application/json:
* schema:
* $ref: "#/components/schemas/AdminGetUploadParams"
* oneOf:
* - type: object
* description: SUMMARY
* required:
* - files
* properties:
* files:
* type: array
* description: The upload's files.
* items:
* oneOf:
* - type: object
* description: The file's files.
* required:
* - name
* - content
* properties:
* name:
* type: string
* title: name
* description: The file's name.
* content:
* type: string
* title: content
* description: The file's content.
* - $ref: "#/components/schemas/File"
* - $ref: "#/components/schemas/FileList"
* description: SUMMARY
* x-codeSamples:
* - lang: Shell
* label: cURL