diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh index 3727310999..178e43fe8f 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/api-keys' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}", + "type": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh index ae9502eea8..2045a6e651 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/api-keys/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh new file mode 100644 index 0000000000..efa7320559 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/api-keys/{id}/sales-channels' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh index 359a39a047..542e982cdf 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns/post.sh @@ -1,2 +1,10 @@ curl -X POST '{backend_url}/admin/campaigns' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Gunner", + "campaign_identifier": "{value}", + "description": "{value}", + "starts_at": "2024-08-24T00:19:14.144Z", + "ends_at": "2024-10-01T06:47:50.133Z" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh index 469123792d..f4c15bbb53 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}/post.sh @@ -2,5 +2,7 @@ curl -X POST '{backend_url}/admin/campaigns/{id}' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Moriah" + "description": "{value}", + "starts_at": "2024-08-10T14:44:10.530Z", + "ends_at": "2024-07-13T17:45:37.462Z" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh new file mode 100644 index 0000000000..a796a09e0b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_campaigns_{id}_promotions/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/campaigns/{id}/promotions' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh index 564406d2c8..8e19534d37 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/collections' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh index 1ed3078733..5062552418 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/collections/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh new file mode 100644 index 0000000000..ecff92ca27 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_collections_{id}_products/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/collections/{id}/products' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh index 5dc5d9806f..79c63c6854 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/customer-groups' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Solon", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh index 2f19abfcce..936f9393fc 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/customer-groups/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Corbin", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/get.sh deleted file mode 100644 index 07089b3972..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/get.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl '{backend_url}/admin/customer-groups/{id}/customers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh new file mode 100644 index 0000000000..8140c7a194 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/customer-groups/{id}/customers' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_batch/post.sh deleted file mode 100644 index 34c79ef48e..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_batch/post.sh +++ /dev/null @@ -1,10 +0,0 @@ -curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "customer_ids": [ - { - "id": "id_dx2Wieq4uGG" - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_remove/post.sh deleted file mode 100644 index 9688dbf20e..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customer-groups_{id}_customers_remove/post.sh +++ /dev/null @@ -1,10 +0,0 @@ -curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "customer_ids": [ - { - "id": "id_oAhMZi39hsjIOqPA6" - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh index ea92b85acf..815a3c4f15 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers/post.sh @@ -1,2 +1,11 @@ curl -X POST '{backend_url}/admin/customers' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Tomas.Toy16@yahoo.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh index 867aa617b0..20ef2e9c61 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}/post.sh @@ -1,2 +1,11 @@ curl -X POST '{backend_url}/admin/customers/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Daren_Rodriguez-Rutherford93@gmail.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh index 2c8b6e8d13..ebac8c6489 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses/post.sh @@ -1,2 +1,17 @@ curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "address_name": "{value}", + "company": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "phone": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh index ad9bd85a74..25b406b1c6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_customers_{id}_addresses_{address_id}/post.sh @@ -1,2 +1,17 @@ curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "address_name": "{value}", + "company": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "phone": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh new file mode 100644 index 0000000000..a9da54ffd5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/draft-orders' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh new file mode 100644 index 0000000000..86761070d9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders/post.sh @@ -0,0 +1,19 @@ +curl -X POST '{backend_url}/admin/draft-orders' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "sales_channel_id": "{value}", + "email": "Bartholome.Goodwin90@yahoo.com", + "customer_id": "{value}", + "region_id": "{value}", + "currency_code": "{value}", + "shipping_methods": [ + { + "shipping_method_id": "{value}", + "order_id": "{value}", + "name": "Cheyanne", + "option_id": "{value}" + } + ], + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh new file mode 100644 index 0000000000..7427f5b2ce --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_draft-orders_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/draft-orders/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh new file mode 100644 index 0000000000..daf5cd737d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-providers/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/fulfillment-providers' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh new file mode 100644 index 0000000000..4a2da2a97c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh new file mode 100644 index 0000000000..309af7936c --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Layla" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh new file mode 100644 index 0000000000..f694c5a87e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh new file mode 100644 index 0000000000..a0dbeae380 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh new file mode 100644 index 0000000000..3b14a475d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Elvis" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_add/post.sh deleted file mode 100644 index 8f84a5fe7a..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_add/post.sh +++ /dev/null @@ -1,10 +0,0 @@ -curl -X POST '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rules": [ - { - "attribute": "{value}" - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_remove/post.sh deleted file mode 100644 index 94808c8c6f..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_remove/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rule_ids": [ - "{value}" - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh new file mode 100644 index 0000000000..9ce5d4f64e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments/post.sh @@ -0,0 +1,46 @@ +curl -X POST '{backend_url}/admin/fulfillments' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "location_id": "{value}", + "provider_id": "{value}", + "delivery_address": { + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "metadata": {} + }, + "items": [ + { + "title": "{value}", + "sku": "{value}", + "quantity": 1667318922870784, + "barcode": "{value}", + "line_item_id": "{value}", + "inventory_item_id": "{value}" + } + ], + "labels": [ + { + "tracking_number": "{value}", + "tracking_url": "{value}", + "label_url": "{value}" + } + ], + "order": {}, + "order_id": "{value}", + "shipping_option_id": "{value}", + "data": {}, + "packed_at": "2024-11-12T18:37:37.122Z", + "shipped_at": "2025-04-13T12:39:42.432Z", + "delivered_at": "2025-01-29T19:05:57.056Z", + "canceled_at": "2025-02-16T02:12:11.763Z", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh new file mode 100644 index 0000000000..c2381712e0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/fulfillments/{id}/cancel' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh new file mode 100644 index 0000000000..5fdaaa229a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh @@ -0,0 +1,12 @@ +curl -X POST '{backend_url}/admin/fulfillments/{id}/shipment' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "labels": [ + { + "tracking_number": "{value}", + "tracking_url": "{value}", + "label_url": "{value}" + } + ] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh index 6c92c8d0e0..444f73740c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items/post.sh @@ -1,2 +1,18 @@ curl -X POST '{backend_url}/admin/inventory-items' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "sku": "{value}", + "hs_code": "{value}", + "weight": 2857134683324416, + "length": 2322256963305472, + "height": 8391220613087232, + "width": 1297863250280448, + "origin_country": "{value}", + "mid_code": "{value}", + "material": "{value}", + "title": "{value}", + "description": "{value}", + "thumbnail": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh index 7de420fdea..ca9c2d104a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}/post.sh @@ -1,2 +1,18 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "sku": "{value}", + "hs_code": "{value}", + "weight": 8979922215239680, + "length": 667491233693696, + "height": 6328111551479808, + "width": 7175104570064896, + "origin_country": "{value}", + "mid_code": "{value}", + "material": "{value}", + "title": "{value}", + "description": "{value}", + "thumbnail": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh new file mode 100644 index 0000000000..166c163b4b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/inventory-items/{id}/location-levels' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh index 0e1ca69def..ae4e9e9072 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh @@ -2,6 +2,5 @@ curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "location_id": "{value}", - "stocked_quantity": 1506469662949376 + "location_id": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh new file mode 100644 index 0000000000..8480742b65 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/get.sh index 248ec00ebb..3a0c61ad84 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/get.sh @@ -1,2 +1 @@ -curl '{backend_url}/admin/invites' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl '{backend_url}/admin/invites' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/post.sh index 55871d44bb..f0911077e5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites/post.sh @@ -1,2 +1,5 @@ curl -X POST '{backend_url}/admin/invites' \ --H 'x-medusa-access-token: {api_token}' +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Whitney_Schultz@gmail.com" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_accept/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_accept/post.sh index 6fcd4de1a5..0e2eae211e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_accept/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_accept/post.sh @@ -1,7 +1,7 @@ curl -X POST '{backend_url}/admin/invites/accept' \ --H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ + "email": "Lila_Zemlak@hotmail.com", "first_name": "{value}", "last_name": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/delete.sh index 15bf7650f9..9c44668d3b 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/invites/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/invites/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/get.sh index 5b852ef83a..53d9caa9a6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}/get.sh @@ -1,2 +1 @@ -curl '{backend_url}/admin/invites/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl '{backend_url}/admin/invites/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}_resend/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}_resend/post.sh index 84d18fbb71..971003faa2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}_resend/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_invites_{id}_resend/post.sh @@ -1,2 +1 @@ -curl -X POST '{backend_url}/admin/invites/{id}/resend' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X POST '{backend_url}/admin/invites/{id}/resend' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh new file mode 100644 index 0000000000..c35070bfe1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/orders' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh new file mode 100644 index 0000000000..362b96e0cb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/orders/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh new file mode 100644 index 0000000000..8cc19fc10d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/orders/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh new file mode 100644 index 0000000000..2ca36e9fbd --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_archive/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/orders/{id}/archive' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh new file mode 100644 index 0000000000..17db17139d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_cancel/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/orders/{id}/cancel' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh new file mode 100644 index 0000000000..0f1a33de13 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_complete/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/orders/{id}/complete' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh new file mode 100644 index 0000000000..494797f6ac --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments/post.sh @@ -0,0 +1,13 @@ +curl -X POST '{backend_url}/admin/orders/{id}/fulfillments' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "items": [ + { + "id": "id_YePfQ6PBCBKvmYyreUt2", + "quantity": 6623610359775232 + } + ], + "location_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh new file mode 100644 index 0000000000..b09f7fdc65 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh new file mode 100644 index 0000000000..6d7d71f581 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh @@ -0,0 +1,12 @@ +curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "items": [ + { + "id": "id_eyih2debIPWMK4kaHGPZ", + "quantity": 7476297089417216 + } + ], + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh new file mode 100644 index 0000000000..7919b77c62 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_payments_payment-providers/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/payments/payment-providers' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh index 1efe400afe..25b84b2e62 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists/post.sh @@ -4,11 +4,6 @@ curl -X POST '{backend_url}/admin/price-lists' \ --data-raw '{ "title": "{value}", "description": "{value}", - "prices": [ - { - "currency_code": "{value}", - "amount": 1270314195484672, - "variant_id": "{value}" - } - ] + "starts_at": "{value}", + "ends_at": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh index d9ac4ad542..bef779f42e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}/post.sh @@ -2,11 +2,7 @@ curl -X POST '{backend_url}/admin/price-lists/{id}' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "prices": [ - { - "currency_code": "{value}", - "amount": 1670236243755008, - "variant_id": "{value}" - } - ] + "description": "{value}", + "starts_at": "{value}", + "ends_at": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh new file mode 100644 index 0000000000..809f6fa0a6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_add/post.sh deleted file mode 100644 index c27d38bbc5..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_add/post.sh +++ /dev/null @@ -1,12 +0,0 @@ -curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "prices": [ - { - "currency_code": "{value}", - "amount": 6595965345595392, - "variant_id": "{value}" - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_remove/post.sh deleted file mode 100644 index dbae883d20..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_prices_batch_remove/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "ids": [ - "{value}" - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh new file mode 100644 index 0000000000..e174727077 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_price-lists_{id}_products/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/price-lists/{id}/products' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/get.sh deleted file mode 100644 index a5576df0f8..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/get.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl '{backend_url}/admin/pricing/rule-types' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/post.sh deleted file mode 100644 index 785b00eaf7..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/pricing/rule-types' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "name": "Thurman", - "rule_attribute": "{value}", - "default_priority": 4640267816665088 -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/delete.sh deleted file mode 100644 index d535b13fa4..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/delete.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/get.sh deleted file mode 100644 index 19323eebc8..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/get.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl '{backend_url}/admin/pricing/rule-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/post.sh deleted file mode 100644 index 89b73e9600..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_pricing_rule-types_{id}/post.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl -X POST '{backend_url}/admin/pricing/rule-types/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh new file mode 100644 index 0000000000..5038056433 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-categories' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh new file mode 100644 index 0000000000..a08aa11d6f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories/post.sh @@ -0,0 +1,8 @@ +curl -X POST '{backend_url}/admin/product-categories' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Vesta", + "parent_category_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh new file mode 100644 index 0000000000..7fb8699c8e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/product-categories/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh new file mode 100644 index 0000000000..908035d8d6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-categories/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh new file mode 100644 index 0000000000..e4cabadb8e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/product-categories/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "parent_category_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh new file mode 100644 index 0000000000..cfd6a809fe --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-categories_{id}_products/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/product-categories/{id}/products' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh new file mode 100644 index 0000000000..c1996a927e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-tags' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh new file mode 100644 index 0000000000..c7f0793cf6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/product-tags' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "value": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh new file mode 100644 index 0000000000..76b3823164 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/product-tags/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh new file mode 100644 index 0000000000..2d5beef1ef --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-tags/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh new file mode 100644 index 0000000000..0e85df080f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-tags_{id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/product-tags/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh new file mode 100644 index 0000000000..298ba1bc80 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-types' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh new file mode 100644 index 0000000000..6dae543255 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/product-types' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "value": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh new file mode 100644 index 0000000000..41d85b9231 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/product-types/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh new file mode 100644 index 0000000000..86eb0e7fe7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/product-types/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh new file mode 100644 index 0000000000..8be86c10fc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_product-types_{id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/product-types/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh index 631af544f9..c0ddca6119 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/products' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh new file mode 100644 index 0000000000..81ba8a99f3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/products/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh index 9b8dac7ef3..50d34ac315 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options/post.sh @@ -1,2 +1,9 @@ curl -X POST '{backend_url}/admin/products/{id}/options' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}", + "values": [ + "{value}" + ] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh index ca930ee9af..1d9e2d5171 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_options_{option_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh index 1315966d84..267923fb23 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/products/{id}/variants' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "title": "{value}", + "prices": [] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh new file mode 100644 index 0000000000..331e8986c6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/products/{id}/variants/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh new file mode 100644 index 0000000000..406d104ffc --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh index b456242794..56948c9bd9 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}/post.sh @@ -1,2 +1,2 @@ curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh new file mode 100644 index 0000000000..a71b17413a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "required_quantity": 7390879820021760, + "inventory_item_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh new file mode 100644 index 0000000000..c9297cbe64 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh new file mode 100644 index 0000000000..011fc0e4fe --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "required_quantity": 5324804697620480 +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh index c378af33df..eba2bc3884 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions/post.sh @@ -1,2 +1,21 @@ curl -X POST '{backend_url}/admin/promotions' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "code": "{value}", + "type": "{value}", + "campaign_id": "{value}", + "application_method": { + "description": "{value}", + "value": 1841223411171328, + "currency_code": "{value}", + "max_quantity": 2960098049654784, + "type": "{value}", + "target_type": "{value}", + "allocation": "{value}", + "target_rules": [], + "buy_rules": [], + "apply_to_quantity": 708643867590656, + "buy_rules_min_quantity": 3167972149428224 + } +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh new file mode 100644 index 0000000000..4d3c48e6ed --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh new file mode 100644 index 0000000000..071bf10e2a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh index 8c890666c1..b1312463d2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/promotions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "campaign_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh new file mode 100644 index 0000000000..8383761d0d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_add/post.sh deleted file mode 100644 index 61240c5ee2..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_add/post.sh +++ /dev/null @@ -1,13 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_remove/post.sh deleted file mode 100644 index b09d3024fa..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_buy-rules_batch_remove/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rule_ids": [ - "{value}" - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh new file mode 100644 index 0000000000..112e23e54e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_add/post.sh deleted file mode 100644 index 86169da188..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_add/post.sh +++ /dev/null @@ -1,13 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_remove/post.sh deleted file mode 100644 index 9dc80df6d9..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_remove/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rule_ids": [ - "{value}" - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_update/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_update/post.sh deleted file mode 100644 index 40612b52a5..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_rules_batch_update/post.sh +++ /dev/null @@ -1,14 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/update' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rules": [ - { - "id": "id_orjnxCxIQlJAp4", - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh new file mode 100644 index 0000000000..9b65005dbb --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_add/post.sh deleted file mode 100644 index 3bb81a928f..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_add/post.sh +++ /dev/null @@ -1,13 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_remove/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_remove/post.sh deleted file mode 100644 index e504709fe4..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_target-rules_batch_remove/post.sh +++ /dev/null @@ -1,8 +0,0 @@ -curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/remove' \ --H 'x-medusa-access-token: {api_token}' \ --H 'Content-Type: application/json' \ ---data-raw '{ - "rule_ids": [ - "{value}" - ] -}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh new file mode 100644 index 0000000000..4a85b6172a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/promotions/{id}/{rule_type}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh index 5904a7d833..bf07c77282 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions/post.sh @@ -1,2 +1,8 @@ curl -X POST '{backend_url}/admin/regions' \ --H 'x-medusa-access-token: {api_token}' +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Heloise", + "currency_code": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh index 7af660e7ef..ac108e991a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_regions_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/regions/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh new file mode 100644 index 0000000000..a2328ea707 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/reservations' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh new file mode 100644 index 0000000000..1c3bc92b9f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations/post.sh @@ -0,0 +1,11 @@ +curl -X POST '{backend_url}/admin/reservations' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "line_item_id": "{value}", + "location_id": "{value}", + "inventory_item_id": "{value}", + "quantity": 3268935814217728, + "description": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh new file mode 100644 index 0000000000..0c8410a3a7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/reservations/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh new file mode 100644 index 0000000000..1984cec62e --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/reservations/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh new file mode 100644 index 0000000000..565a7c4131 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_reservations_{id}/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/reservations/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "description": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh new file mode 100644 index 0000000000..26e49166a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/return-reasons' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh new file mode 100644 index 0000000000..903d197b49 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/return-reasons' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "value": "{value}", + "label": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh new file mode 100644 index 0000000000..24ef4616e0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh new file mode 100644 index 0000000000..3693f27785 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/return-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh new file mode 100644 index 0000000000..7a36891f75 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_return-reasons_{id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/return-reasons/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh new file mode 100644 index 0000000000..108c2d6363 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/returns' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh new file mode 100644 index 0000000000..c39886ecb9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns/post.sh @@ -0,0 +1,20 @@ +curl -X POST '{backend_url}/admin/returns' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}", + "items": [ + { + "id": "id_7DO5H2LbSN3p7IzB", + "quantity": 1357590174892032, + "reason_id": "{value}", + "note": "{value}" + } + ], + "return_shipping": { + "option_id": "{value}", + "price": 5112171463704576 + }, + "internal_note": "{value}", + "location_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh new file mode 100644 index 0000000000..2cc8ac827d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/returns/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh new file mode 100644 index 0000000000..dbc70ff89a --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_cancel/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/returns/{id}/cancel' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh new file mode 100644 index 0000000000..f900c629fa --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_returns_{id}_receive/post.sh @@ -0,0 +1,15 @@ +curl -X POST '{backend_url}/admin/returns/{id}/receive' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "return_id": "{value}", + "items": [ + { + "id": "id_qfy3t6cU7m8O5cJ5zs", + "quantity": 6429460591017984, + "reason_id": "{value}", + "note": "{value}" + } + ], + "internal_note": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh index 3f31f0b065..60d046d7d2 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels/post.sh @@ -1,2 +1,8 @@ curl -X POST '{backend_url}/admin/sales-channels' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Linnea", + "description": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh index 9705aca3aa..8fba95522e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}/post.sh @@ -1,2 +1,7 @@ curl -X POST '{backend_url}/admin/sales-channels/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "description": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh new file mode 100644 index 0000000000..8867864420 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/sales-channels/{id}/products' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products_batch_add/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products_batch_add/post.sh deleted file mode 100644 index 7e78a2b44f..0000000000 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_sales-channels_{id}_products_batch_add/post.sh +++ /dev/null @@ -1,2 +0,0 @@ -curl -X POST '{backend_url}/admin/sales-channels/{id}/products/batch/add' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh new file mode 100644 index 0000000000..54954506e0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/shipping-options' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh new file mode 100644 index 0000000000..2b40e026ac --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options/post.sh @@ -0,0 +1,16 @@ +curl -X POST '{backend_url}/admin/shipping-options' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Julie", + "service_zone_id": "{value}", + "shipping_profile_id": "{value}", + "price_type": "{value}", + "provider_id": "{value}", + "type": { + "label": "{value}", + "description": "{value}", + "code": "{value}" + }, + "prices": [] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh new file mode 100644 index 0000000000..68324bddb5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh new file mode 100644 index 0000000000..fb77cb94ce --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/shipping-options/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh new file mode 100644 index 0000000000..797474e738 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh new file mode 100644 index 0000000000..7609587e4b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/shipping-profiles' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh new file mode 100644 index 0000000000..b448bcb6ca --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles/post.sh @@ -0,0 +1,8 @@ +curl -X POST '{backend_url}/admin/shipping-profiles' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Percy", + "type": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh new file mode 100644 index 0000000000..a8cd54c867 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh new file mode 100644 index 0000000000..7c4bc5043b --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/shipping-profiles/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh new file mode 100644 index 0000000000..54901b1199 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-profiles_{id}/post.sh @@ -0,0 +1,6 @@ +curl -X POST '{backend_url}/admin/shipping-profiles/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh new file mode 100644 index 0000000000..f7af7633f4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/stock-locations' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh index 9e40419982..4f39ebfb13 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations/post.sh @@ -2,5 +2,7 @@ curl -X POST '{backend_url}/admin/stock-locations' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Dorthy" + "name": "Maryam", + "address_id": "{value}", + "metadata": {} }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh new file mode 100644 index 0000000000..434c74b5b3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/stock-locations/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "address_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh new file mode 100644 index 0000000000..239f55fbee --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh @@ -0,0 +1,7 @@ +curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-sets' \ +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Helene", + "type": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh new file mode 100644 index 0000000000..d66bae0b04 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/stock-locations/{id}/sales-channels' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh index 292ff49d10..63b7f51e17 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_stores_{id}/post.sh @@ -1,2 +1,10 @@ curl -X POST '{backend_url}/admin/stores/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "name": "Melvina", + "default_sales_channel_id": "{value}", + "default_region_id": "{value}", + "default_location_id": "{value}", + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh index 741f31d081..7250855c52 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates/post.sh @@ -2,6 +2,7 @@ curl -X POST '{backend_url}/admin/tax-rates' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Emilio", - "tax_region_id": "{value}" + "name": "Kaylin", + "tax_region_id": "{value}", + "metadata": {} }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh index f85107c680..f6e7429ba6 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-rates_{id}/post.sh @@ -1,2 +1,6 @@ curl -X POST '{backend_url}/admin/tax-rates/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +-H 'x-medusa-access-token: {api_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh new file mode 100644 index 0000000000..429eacab74 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/tax-regions' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh index 67ad603498..16738887b3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions/post.sh @@ -2,5 +2,8 @@ curl -X POST '{backend_url}/admin/tax-regions' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "country_code": "{value}" + "country_code": "{value}", + "province_code": "{value}", + "parent_id": "{value}", + "metadata": {} }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh new file mode 100644 index 0000000000..59ebcb1e3d --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/tax-regions/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh new file mode 100644 index 0000000000..84911b72b1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/uploads' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh new file mode 100644 index 0000000000..61735226f5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/delete.sh @@ -0,0 +1,2 @@ +curl -X DELETE '{backend_url}/admin/uploads/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh new file mode 100644 index 0000000000..196d8224ab --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_uploads_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/uploads/{id}' \ +-H 'x-medusa-access-token: {api_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/get.sh index 6bdef51bd1..eab49938f3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/get.sh @@ -1,2 +1 @@ -curl '{backend_url}/admin/users' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl '{backend_url}/admin/users' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh index 054dc2e9f9..086927eca5 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users/post.sh @@ -1,2 +1,5 @@ curl -X POST '{backend_url}/admin/users' \ --H 'x-medusa-access-token: {api_token}' +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Janie42@hotmail.com" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_me/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_me/get.sh index c47e54bff3..efa0bb3267 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_me/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_me/get.sh @@ -1,2 +1 @@ -curl '{backend_url}/admin/users/me' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl '{backend_url}/admin/users/me' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/delete.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/delete.sh index d89b51ae7b..0b6c18035c 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/delete.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/delete.sh @@ -1,2 +1 @@ -curl -X DELETE '{backend_url}/admin/users/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl -X DELETE '{backend_url}/admin/users/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/get.sh index a30ecf3e5c..80950321d3 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/get.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/get.sh @@ -1,2 +1 @@ -curl '{backend_url}/admin/users/{id}' \ --H 'x-medusa-access-token: {api_token}' \ No newline at end of file +curl '{backend_url}/admin/users/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/post.sh index 7e0ec197ef..a6abf6df2e 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_users_{id}/post.sh @@ -1,6 +1,7 @@ curl -X POST '{backend_url}/admin/users/{id}' \ --H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ + "first_name": "{value}", + "last_name": "{value}", "avatar_url": "{value}" }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/responses/400_error.yaml b/www/apps/api-reference/specs/admin/components/responses/400_error.yaml index b960f05fb4..f37bffa613 100644 --- a/www/apps/api-reference/specs/admin/components/responses/400_error.yaml +++ b/www/apps/api-reference/specs/admin/components/responses/400_error.yaml @@ -1,14 +1,10 @@ -description: Client Error or Multiple Errors +description: Client Error content: application/json: schema: - oneOf: - - $ref: ../schemas/Error.yaml - - $ref: ../schemas/MultipleErrors.yaml + $ref: ../schemas/Error.yaml examples: not_allowed: $ref: ../examples/not_allowed_error.yaml invalid_data: $ref: ../examples/invalid_data_error.yaml - MultipleErrors: - $ref: ../examples/multiple_errors.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml new file mode 100644 index 0000000000..72b7d36198 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminArchiveOrder +required: + - order_id +properties: + order_id: + type: string + title: order_id + description: The order's order id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductRequest.yaml new file mode 100644 index 0000000000..b747877660 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductRequest.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductRequest +properties: + create: + type: array + description: The product's create. + items: + $ref: ./AdminCreateProduct.yaml + update: + type: array + description: The product's update. + items: + $ref: ./AdminUpdateProduct.yaml + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml new file mode 100644 index 0000000000..ed7d417345 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The product's created. + items: + $ref: ./AdminProduct.yaml + updated: + type: array + description: The product's updated. + items: + $ref: ./AdminProduct.yaml + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantRequest.yaml new file mode 100644 index 0000000000..846c8aea3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantRequest.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductVariantRequest +properties: + create: + type: array + description: The product's create. + items: + $ref: ./AdminCreateProductVariant.yaml + update: + type: array + description: The product's update. + items: + $ref: ./AdminUpdateProductVariant.yaml + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml new file mode 100644 index 0000000000..383fe37898 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchProductVariantResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductVariantResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The product's created. + items: + $ref: ./AdminProductVariant.yaml + updated: + type: array + description: The product's updated. + items: + $ref: ./AdminProductVariant.yaml + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCancelFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCancelFulfillment.yaml new file mode 100644 index 0000000000..57e177eccc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCancelFulfillment.yaml @@ -0,0 +1,3 @@ +type: object +description: SUMMARY +x-schemaName: AdminCancelFulfillment diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml new file mode 100644 index 0000000000..1dc07dbed4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCollection.yaml @@ -0,0 +1,39 @@ +type: object +description: The parent's collection. +x-schemaName: AdminCollection +properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + type: object + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml new file mode 100644 index 0000000000..c9efe9e5a2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCompleteOrder.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminCompleteOrder +required: + - order_id +properties: + order_id: + type: string + title: order_id + description: The order's order id. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml similarity index 87% rename from www/apps/api-reference/specs/store/components/schemas/CreateApiKey.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml index ef17e6e6a1..1965ae3238 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateApiKey.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApiKey.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: CreateApiKey +x-schemaName: AdminCreateApiKey required: - title - type @@ -12,5 +12,5 @@ properties: type: type: string enum: - - secret - publishable + - secret diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml similarity index 56% rename from www/apps/api-reference/specs/admin/components/schemas/CreateProductCollection.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml index adfc9a52a2..2a9161c132 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml @@ -1,8 +1,9 @@ type: object description: SUMMARY -x-schemaName: CreateProductCollection +x-schemaName: AdminCreateCollection required: - title + - metadata properties: title: type: string @@ -12,14 +13,6 @@ properties: type: string title: handle description: The collection's handle. - product_ids: - type: array - description: The collection's product ids. - items: - type: string - title: product_ids - description: The product id's product ids. metadata: type: object description: The collection's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml similarity index 82% rename from www/apps/api-reference/specs/store/components/schemas/CustomerUpdatableFields.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml index 96735acdd0..9b448177ad 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CustomerUpdatableFields.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomer.yaml @@ -1,7 +1,19 @@ type: object description: SUMMARY -x-schemaName: CustomerUpdatableFields +x-schemaName: AdminCreateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone + - metadata properties: + email: + type: string + title: email + description: The customer's email. + format: email company_name: type: string title: company_name @@ -14,11 +26,6 @@ properties: type: string title: last_name description: The customer's last name. - email: - type: string - title: email - description: The customer's email. - format: email phone: type: string title: phone @@ -26,4 +33,3 @@ properties: metadata: type: object description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml similarity index 87% rename from www/apps/api-reference/specs/admin/components/schemas/CreateCustomerAddress.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml index 291601e951..744dd0a854 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerAddress.yaml @@ -1,8 +1,19 @@ type: object description: SUMMARY -x-schemaName: CreateCustomerAddress +x-schemaName: AdminCreateCustomerAddress required: - - customer_id + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata properties: address_name: type: string @@ -16,10 +27,6 @@ properties: type: boolean title: is_default_billing description: The customer's is default billing. - customer_id: - type: string - title: customer_id - description: The customer's customer id. company: type: string title: company @@ -63,4 +70,3 @@ properties: metadata: type: object description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml similarity index 74% rename from www/apps/api-reference/specs/admin/components/schemas/CustomerGroupUpdatableFields.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml index 4040e71cc0..411237b91f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupUpdatableFields.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml @@ -1,6 +1,9 @@ type: object description: SUMMARY -x-schemaName: CustomerGroupUpdatableFields +x-schemaName: AdminCreateCustomerGroup +required: + - name + - metadata properties: name: type: string @@ -9,4 +12,3 @@ properties: metadata: type: object description: The customer group's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml new file mode 100644 index 0000000000..7d1debb06d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -0,0 +1,184 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateFulfillment +required: + - location_id + - provider_id + - delivery_address + - items + - labels + - order + - order_id + - shipping_option_id + - data + - packed_at + - shipped_at + - delivered_at + - canceled_at + - metadata +properties: + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + delivery_address: + type: object + description: The fulfillment's delivery address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + phone: + type: string + title: phone + description: The delivery address's phone. + company: + type: string + title: company + description: The delivery address's company. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + metadata: + type: object + description: The delivery address's metadata. + items: + type: array + description: The fulfillment's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - quantity + - barcode + - line_item_id + - inventory_item_id + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + quantity: + type: number + title: quantity + description: The item's quantity. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + order: + type: object + description: The fulfillment's order. + order_id: + type: string + title: order_id + description: The fulfillment's order id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + data: + type: object + description: The fulfillment's data. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + metadata: + type: object + description: The fulfillment's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml similarity index 85% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsReq.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml index f82a0dcb72..bc76085c82 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml @@ -1,11 +1,11 @@ type: object description: SUMMARY -x-schemaName: AdminPostPriceListsReq +x-schemaName: AdminCreatePriceList required: - title - description - - type - - prices + - starts_at + - ends_at properties: title: type: string @@ -23,19 +23,31 @@ properties: type: string title: ends_at description: The price list's ends at. - status: {} - type: {} + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. prices: type: array description: The price list's prices. items: type: object description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq required: - currency_code - amount - variant_id + - min_quantity + - max_quantity properties: currency_code: type: string @@ -60,8 +72,3 @@ properties: rules: type: object description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml new file mode 100644 index 0000000000..a582cab145 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml @@ -0,0 +1,148 @@ +type: object +description: The create's details. +x-schemaName: AdminCreateProduct +required: + - title +properties: + title: + type: string + title: title + description: The create's title. + subtitle: + type: string + title: subtitle + description: The create's subtitle. + description: + type: string + title: description + description: The create's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The create's is giftcard. + discountable: + type: boolean + title: discountable + description: The create's discountable. + images: + type: array + description: The create's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The create's thumbnail. + handle: + type: string + title: handle + description: The create's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The create's type id. + collection_id: + type: string + title: collection_id + description: The create's collection id. + categories: + type: array + description: The create's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The create's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The create's options. + items: + $ref: ./AdminCreateProductOption.yaml + variants: + type: array + description: The create's variants. + items: + $ref: ./AdminCreateProductVariant.yaml + sales_channels: + type: array + description: The create's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductOption.yaml new file mode 100644 index 0000000000..156ef7cf2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductOption.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateProductOption +required: + - title + - values +properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml new file mode 100644 index 0000000000..16419ecccd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml @@ -0,0 +1,82 @@ +type: object +description: The create's details. +x-schemaName: AdminCreateProductVariant +required: + - title + - prices +properties: + title: + type: string + title: title + description: The create's title. + sku: + type: string + title: sku + description: The create's sku. + ean: + type: string + title: ean + description: The create's ean. + upc: + type: string + title: upc + description: The create's upc. + barcode: + type: string + title: barcode + description: The create's barcode. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The create's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The create's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The create's variant rank. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + prices: + type: array + description: The create's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The create's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml new file mode 100644 index 0000000000..f0178db1e1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml @@ -0,0 +1,23 @@ +type: object +description: The price's prices. +x-schemaName: AdminCreateProductVariantPrice +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. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml new file mode 100644 index 0000000000..95757db18b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateSalesChannel.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateSalesChannel +required: + - name + - description + - metadata +properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml new file mode 100644 index 0000000000..3d5448c4bf --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShipment.yaml @@ -0,0 +1,29 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateShipment +required: + - labels +properties: + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml new file mode 100644 index 0000000000..8e3ef68737 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateStockLocation.yaml @@ -0,0 +1,64 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateStockLocation +required: + - name + - address_id + - metadata +properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml similarity index 92% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml index 31f7a9f5ac..0ae78fdda5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml @@ -1,9 +1,10 @@ type: object description: SUMMARY -x-schemaName: AdminPostTaxRatesReq +x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - metadata properties: rate: type: number @@ -19,7 +20,6 @@ properties: items: type: object description: The rule's rules. - x-schemaName: CreateTaxRateRule required: - reference - reference_id @@ -51,4 +51,3 @@ properties: metadata: type: object description: The tax rate's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRateRule.yaml similarity index 85% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRateRule.yaml index 95d4bdec29..46cf869c16 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRateRule.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostTaxRatesTaxRateRulesReq +x-schemaName: AdminCreateTaxRateRule required: - reference - reference_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml new file mode 100644 index 0000000000..34f34c56f2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -0,0 +1,51 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateTaxRegion +required: + - country_code + - province_code + - parent_id + - metadata +properties: + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + default_tax_rate: + type: object + description: The tax region's default tax rate. + required: + - name + - metadata + properties: + rate: + type: number + title: rate + description: The default tax rate's rate. + code: + type: string + title: code + description: The default tax rate's code. + name: + type: string + title: name + description: The default tax rate's name. + is_combinable: + type: string + enum: + - 'true' + - 'false' + metadata: + type: object + description: The default tax rate's metadata. + metadata: + type: object + description: The tax region's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml new file mode 100644 index 0000000000..6674b16f20 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateVariantInventoryItem +required: + - required_quantity + - inventory_item_id +properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The product's inventory item id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml similarity index 74% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml index 21dd2c9bf9..969982fcb4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostWorkflowsAsyncResponseReq +x-schemaName: AdminCreateWorkflowsAsyncResponse required: - transaction_id - step_id @@ -15,4 +15,8 @@ properties: description: The workflows execution's step id. response: {} compensate_input: {} - action: {} + action: + type: string + enum: + - invoke + - compensate diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsRunReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsRun.yaml similarity index 82% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsRunReq.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsRun.yaml index f54c4288d4..9d4e5dc6f3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsRunReq.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateWorkflowsRun.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostWorkflowsRunReq +x-schemaName: AdminCreateWorkflowsRun properties: input: {} transaction_id: diff --git a/www/apps/api-reference/specs/store/components/schemas/Customer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml similarity index 56% rename from www/apps/api-reference/specs/store/components/schemas/Customer.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml index 063a4ff87a..f1f78d98b3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Customer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml @@ -1,7 +1,26 @@ type: object -description: The context's customer. -x-schemaName: Customer +description: The customer's details. +x-schemaName: AdminCustomer +required: + - has_account + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses properties: + has_account: + type: boolean + title: has_account + description: The customer's has account. + groups: + type: array + description: The customer's groups. + items: + $ref: ./AdminCustomerGroup.yaml id: type: string title: id @@ -35,53 +54,30 @@ properties: type: array description: The customer's addresses. items: - type: object - description: The address's addresses. - x-schemaName: CustomerAddress - properties: {} + $ref: ./BaseCustomerAddress.yaml phone: type: string title: phone description: The customer's phone. - groups: - type: array - description: The customer's groups. - items: - type: object - description: The group's groups. - properties: {} metadata: type: object description: The customer's metadata. - properties: {} created_by: type: string title: created_by description: The customer's created by. deleted_at: - oneOf: - - type: string - title: deleted_at - description: The customer's deleted at. - - type: string - title: deleted_at - description: The customer's deleted at. - format: date-time + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. created_at: - oneOf: - - type: string - title: created_at - description: The customer's created at. - - type: string - title: created_at - description: The customer's created at. - format: date-time + type: string + format: date-time + title: created_at + description: The customer's created at. updated_at: - oneOf: - - type: string - title: updated_at - description: The customer's updated at. - - type: string - title: updated_at - description: The customer's updated at. - format: date-time + type: string + format: date-time + title: updated_at + description: The customer's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml new file mode 100644 index 0000000000..c4610e86ec --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml @@ -0,0 +1,37 @@ +type: object +description: The group's groups. +x-schemaName: AdminCustomerGroup +required: + - id + - name + - customers + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The group's ID. + name: + type: string + title: name + description: The group's name. + customers: + type: array + description: The group's customers. + items: + $ref: ./BaseCustomer.yaml + metadata: + type: object + description: The group's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The group's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The group's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml deleted file mode 100644 index a391a2918f..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq -properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml new file mode 100644 index 0000000000..9d7d2c4f6a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's provider. +x-schemaName: AdminFulfillmentProvider diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml new file mode 100644 index 0000000000..bff56cf421 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml @@ -0,0 +1,44 @@ +type: object +description: The fulfillment set's details. +x-schemaName: AdminFulfillmentSet +required: + - id + - name + - type + - service_zones + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The fulfillment set's ID. + name: + type: string + title: name + description: The fulfillment set's name. + type: + type: string + title: type + description: The fulfillment set's type. + service_zones: + type: array + description: The fulfillment set's service zones. + items: + $ref: ./AdminServiceZone.yaml + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment set's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment set's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment set's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml new file mode 100644 index 0000000000..e21a663cda --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentSetDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + default: fulfillment_set + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml new file mode 100644 index 0000000000..b5f823157e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentSetResponse +required: + - fulfillment_set +properties: + fulfillment_set: + $ref: ./AdminFulfillmentSet.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml new file mode 100644 index 0000000000..6684ce0d57 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml @@ -0,0 +1,3 @@ +type: object +description: The geo zone's geo zones. +x-schemaName: AdminGeoZone diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml deleted file mode 100644 index 26145b7de3..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml +++ /dev/null @@ -1,31 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPricingRuleTypesParams -properties: - rule_attribute: - type: array - description: The pricing's rule attribute. - items: - type: string - title: rule_attribute - description: The rule attribute's details. - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - offset: - type: number - title: offset - description: The pricing's offset. - limit: - type: number - title: limit - description: The pricing's limit. - order: - type: string - title: order - description: The pricing's order. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml deleted file mode 100644 index d50e3cf0bf..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml +++ /dev/null @@ -1,12 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPricingRuleTypesRuleTypeParams -properties: - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetProductsParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetProductsParams.yaml deleted file mode 100644 index 93db8609d9..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetProductsParams.yaml +++ /dev/null @@ -1,767 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetProductsParams -properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The product's status. - items: {} - title: - type: string - title: title - description: The product's title. - handle: - type: string - title: handle - description: The product's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - price_list_id: - type: array - description: The product's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The product's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The product's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The product's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The product's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The product's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The product's expand. - fields: - type: string - title: fields - description: The product's fields. - offset: - type: number - title: offset - description: The product's offset. - limit: - type: number - title: limit - description: The product's limit. - order: - type: string - title: order - description: The product's order. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPromotionsParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPromotionsParams.yaml deleted file mode 100644 index a38aac4435..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetPromotionsParams.yaml +++ /dev/null @@ -1,28 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPromotionsParams -properties: - code: - type: string - title: code - description: The promotion's code. - expand: - type: string - title: expand - description: The promotion's expand. - fields: - type: string - title: fields - description: The promotion's fields. - offset: - type: number - title: offset - description: The promotion's offset. - limit: - type: number - title: limit - description: The promotion's limit. - order: - type: string - title: order - description: The promotion's order. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml new file mode 100644 index 0000000000..16e5d808f7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGetUploadParams.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminGetUploadParams +properties: + fields: + type: string + title: fields + description: The upload's fields. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml new file mode 100644 index 0000000000..849a186934 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCancelFulfillment.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCancelFulfillment +properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml new file mode 100644 index 0000000000..59a7bc492a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateFulfillment.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCreateFulfillment +required: + - items + - location_id + - metadata +properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml new file mode 100644 index 0000000000..75ce832164 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderCreateShipment.yaml @@ -0,0 +1,55 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCreateShipment +required: + - items + - metadata +properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCampaignsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCampaignsReq.yaml deleted file mode 100644 index 2794f6b7b3..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCampaignsReq.yaml +++ /dev/null @@ -1,46 +0,0 @@ -type: object -description: The promotion's campaign. -x-schemaName: AdminPostCampaignsReq -required: - - name -properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. - budget: - $ref: ./CampaignBudget.yaml - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - x-schemaName: IdObject - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml deleted file mode 100644 index b6d536cac5..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq -required: - - customer_ids -properties: - customer_ids: - type: array - description: The customer group's customer ids. - items: - type: object - description: The customer id's customer ids. - x-schemaName: CustomerGroupsBatchCustomer - required: - - id - properties: - id: - type: string - title: id - description: The customer id's ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml deleted file mode 100644 index ed87f2705e..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml +++ /dev/null @@ -1,34 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq -required: - - rules -properties: - rules: - type: array - description: The fulfillment's rules. - items: - type: object - description: The rule's rules. - x-schemaName: FulfillmentRuleCreate - required: - - operator - - attribute - - value - properties: - operator: {} - 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml deleted file mode 100644 index dcfdf3d238..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq -required: - - rule_ids -properties: - rule_ids: - type: array - description: The fulfillment's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml deleted file mode 100644 index bf0295b65b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml +++ /dev/null @@ -1,56 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsInventoryItemReq -properties: - sku: - type: string - title: sku - description: The inventory item's sku. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - 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. - weight: - type: number - title: weight - description: The inventory item's weight. - height: - type: number - title: height - description: The inventory item's height. - length: - type: number - title: length - description: The inventory item's length. - width: - type: number - title: width - description: The inventory item's width. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml deleted file mode 100644 index 444b8870c0..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml +++ /dev/null @@ -1,12 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq -properties: - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml deleted file mode 100644 index 0bdd7938fe..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq -required: - - location_id - - stocked_quantity -properties: - location_id: - type: string - title: location_id - description: The inventory item's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml deleted file mode 100644 index d97997e360..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml +++ /dev/null @@ -1,56 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsReq -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. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - metadata: - type: object - description: The inventory item's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml deleted file mode 100644 index 0843980500..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInvitesInviteAcceptReq -required: - - first_name - - last_name -properties: - first_name: - type: string - title: first_name - description: The invite's first name. - last_name: - type: string - title: last_name - description: The invite's last name. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml deleted file mode 100644 index aa5a8cc8bc..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPaymentsCapturesReq -properties: - amount: - type: number - title: amount - description: The payment's amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml deleted file mode 100644 index 8afa44416d..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPaymentsRefundsReq -properties: - amount: - type: number - title: amount - description: The payment's amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml deleted file mode 100644 index 57b5300434..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml +++ /dev/null @@ -1,42 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq -required: - - prices -properties: - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml deleted file mode 100644 index 7e3adbbf6a..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq -required: - - ids -properties: - ids: - type: array - description: The price list's ids. - items: - type: string - title: ids - description: The id's ids. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml deleted file mode 100644 index 544cae040d..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml +++ /dev/null @@ -1,64 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListReq -required: - - prices -properties: - title: - type: string - title: title - description: The price list's title. - description: - type: string - title: description - description: The price list's description. - starts_at: - type: string - title: starts_at - description: The price list's starts at. - ends_at: - type: string - title: ends_at - description: The price list's ends at. - status: {} - type: {} - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml deleted file mode 100644 index 4913c040f5..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPricingRuleTypesReq -required: - - name - - rule_attribute - - default_priority -properties: - name: - type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml deleted file mode 100644 index 0639dbbadc..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml +++ /dev/null @@ -1,16 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPricingRuleTypesRuleTypeReq -properties: - name: - type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml deleted file mode 100644 index a00d8d6922..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml +++ /dev/null @@ -1,49 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionReq -properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: {} - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - $ref: ./AdminPostCampaignsReq.yaml - application_method: - $ref: ./ApplicationMethodsMethodPostReq.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml deleted file mode 100644 index cfa30aaeb4..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml +++ /dev/null @@ -1,34 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq -required: - - rules -properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml deleted file mode 100644 index 2b74ae724d..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq -required: - - rule_ids -properties: - rule_ids: - type: array - description: The promotion's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml deleted file mode 100644 index cbe025b43c..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml +++ /dev/null @@ -1,38 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq -required: - - rules -properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: UpdatePromotionRule - required: - - id - - attribute - - values - properties: - id: - type: string - title: id - description: The rule's ID. - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml new file mode 100644 index 0000000000..d097909bcc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -0,0 +1,44 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReceiveReturnsReqSchema +required: + - return_id + - items + - internal_note +properties: + return_id: + type: string + title: return_id + description: The return's return id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml new file mode 100644 index 0000000000..6f178e3e31 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml @@ -0,0 +1,72 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReqSchema +required: + - order_id + - items + - return_shipping + - internal_note + - location_id +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + internal_note: + type: string + title: internal_note + description: The return's internal note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml deleted file mode 100644 index a8c1dac40b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostStockLocationsReq -required: - - name -properties: - name: - type: string - title: name - description: The stock location's name. - address: - $ref: ./StockLocationAddress.yaml - address_id: - type: string - title: address_id - description: The stock location's address id. - metadata: - type: object - description: The stock location's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml deleted file mode 100644 index a6c334bdc6..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml +++ /dev/null @@ -1,41 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostTaxRatesTaxRateReq -properties: - code: - type: string - title: code - description: The tax rate's code. - name: - type: string - title: name - description: The tax rate's name. - region_id: - type: string - title: region_id - description: The tax rate's region id. - rate: - type: number - title: rate - description: The tax rate's rate. - products: - type: array - description: The tax rate's products. - items: - type: string - title: products - description: The product's products. - shipping_options: - type: array - description: The tax rate's shipping options. - items: - type: string - title: shipping_options - description: The shipping option's shipping options. - product_types: - type: array - description: The tax rate's product types. - items: - type: string - title: product_types - description: The product type's product types. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRegionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRegionsReq.yaml deleted file mode 100644 index 74c8a85d31..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRegionsReq.yaml +++ /dev/null @@ -1,24 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostTaxRegionsReq -required: - - country_code -properties: - country_code: - type: string - title: country_code - description: The tax region's country code. - province_code: - type: string - title: province_code - description: The tax region's province code. - parent_id: - type: string - title: parent_id - description: The tax region's parent id. - default_tax_rate: - $ref: ./CreateDefaultTaxRate.yaml - metadata: - type: object - description: The tax region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml new file mode 100644 index 0000000000..c63019f47d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPrice.yaml @@ -0,0 +1,62 @@ +type: object +description: The price's prices. +x-schemaName: AdminPrice +required: + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml new file mode 100644 index 0000000000..f4ae136c2c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -0,0 +1,167 @@ +type: object +description: The product's parent. +x-schemaName: AdminProduct +required: + - type + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id +properties: + collection: + $ref: ./AdminCollection.yaml + categories: + type: array + description: The parent's categories. + items: + $ref: ./AdminProductCategory.yaml + sales_channels: + type: array + description: The parent's sales channels. + items: + $ref: ./AdminSalesChannel.yaml + variants: + type: array + description: The parent's variants. + items: + $ref: ./AdminProductVariant.yaml + type: + type: object + title: + type: string + title: title + description: The parent's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The parent's length. + options: + type: array + description: The parent's options. + items: + $ref: ./BaseProductOption.yaml + description: + type: string + title: description + description: The parent's description. + id: + type: string + title: id + description: The parent's ID. + handle: + type: string + title: handle + description: The parent's handle. + metadata: + type: object + description: The parent's metadata. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + width: + type: number + title: width + description: The parent's width. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. + subtitle: + type: string + title: subtitle + description: The parent's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The parent's is giftcard. + collection_id: + type: string + title: collection_id + description: The parent's collection id. + type_id: + type: string + title: type_id + description: The parent's type id. + tags: + type: array + description: The parent's tags. + items: + $ref: ./BaseProductTag.yaml + images: + type: array + description: The parent's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The parent's discountable. + external_id: + type: string + title: external_id + description: The parent's external id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml new file mode 100644 index 0000000000..1de3721e0e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategory.yaml @@ -0,0 +1,77 @@ +type: object +description: The category's categories. +x-schemaName: AdminProductCategory +required: + - category_children + - parent_category + - name + - description + - id + - handle + - created_at + - updated_at + - deleted_at + - parent_category_id + - is_internal + - is_active + - rank +properties: + category_children: + type: array + description: The category's category children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + handle: + type: string + title: handle + description: The category's handle. + created_at: + type: string + format: date-time + title: created_at + description: The category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The category's deleted at. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. + is_active: + type: boolean + title: is_active + description: The category's is active. + rank: + type: number + title: rank + description: The category's rank. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml new file mode 100644 index 0000000000..542fca2356 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryListResponse +required: + - limit + - offset + - count + - product_categories +properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml new file mode 100644 index 0000000000..b46adcf4e2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoryResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryResponse +required: + - product_category +properties: + product_category: + $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml new file mode 100644 index 0000000000..65b2edf6c2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + type: object + description: The product's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml new file mode 100644 index 0000000000..bb9c3717ae --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml @@ -0,0 +1,44 @@ +type: object +description: The product's product option. +x-schemaName: AdminProductOption +required: + - id + - title +properties: + id: + type: string + title: id + description: The product option's ID. + title: + type: string + title: title + description: The product option's title. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The product option's product id. + values: + type: array + description: The product option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The product option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product option's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml new file mode 100644 index 0000000000..c67be976b3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductOptionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product_option + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml new file mode 100644 index 0000000000..c609e7d1d8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductOptionResponse +required: + - product_option +properties: + product_option: + $ref: ./AdminProductOption.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml new file mode 100644 index 0000000000..1c3d489857 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductResponse +required: + - product +properties: + product: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml new file mode 100644 index 0000000000..a5255e3ae5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -0,0 +1,128 @@ +type: object +description: The updated's details. +x-schemaName: AdminProductVariant +required: + - prices + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at +properties: + prices: + type: array + description: The updated's prices. + items: + $ref: ./AdminPrice.yaml + id: + type: string + title: id + description: The updated's ID. + title: + type: string + title: title + description: The updated's title. + sku: + type: string + title: sku + description: The updated's sku. + barcode: + type: string + title: barcode + description: The updated's barcode. + ean: + type: string + title: ean + description: The updated's ean. + upc: + type: string + title: upc + description: The updated's upc. + allow_backorder: + type: boolean + title: allow_backorder + description: The updated's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The updated's manage inventory. + hs_code: + type: string + title: hs_code + description: The updated's hs code. + origin_country: + type: string + title: origin_country + description: The updated's origin country. + mid_code: + type: string + title: mid_code + description: The updated's mid code. + material: + type: string + title: material + description: The updated's material. + weight: + type: number + title: weight + description: The updated's weight. + length: + type: number + title: length + description: The updated's length. + height: + type: number + title: height + description: The updated's height. + width: + type: number + title: width + description: The updated's width. + options: + type: array + description: The updated's options. + items: + $ref: ./BaseProductOptionValue.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The updated's product id. + variant_rank: + type: number + title: variant_rank + description: The updated's variant rank. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. + metadata: + type: object + description: The updated's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml new file mode 100644 index 0000000000..dc3b12dd34 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: variant + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml new file mode 100644 index 0000000000..a6a154c417 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml @@ -0,0 +1,276 @@ +type: object +description: The product's variants. +x-schemaName: AdminProductVariantParams +properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant's fields. + $and: + type: array + description: The variant's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $and's sku. + - type: array + description: The $and's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $and's options. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + $or: + type: array + description: The variant's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $or's sku. + - type: array + description: The $or's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $or's options. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml new file mode 100644 index 0000000000..cb5298721d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantResponse +required: + - variant +properties: + variant: + $ref: ./AdminProductVariant.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml new file mode 100644 index 0000000000..7e99903e5b --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminRevokeApiKey +properties: + revoke_in: + type: number + title: revoke_in + description: The api key's revoke in. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml new file mode 100644 index 0000000000..4fb73f820d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml @@ -0,0 +1,47 @@ +type: object +description: The sales channel's sales channels. +x-schemaName: AdminSalesChannel +required: + - id + - name + - description + - is_disabled + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The sales channel's ID. + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The sales channel's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The sales channel's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The sales channel's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml new file mode 100644 index 0000000000..d3a3547a06 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml @@ -0,0 +1,50 @@ +type: object +description: The service zone's service zones. +x-schemaName: AdminServiceZone +required: + - id + - name + - fulfillment_set_id + - geo_zones + - shipping_options + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The service zone's ID. + name: + type: string + title: name + description: The service zone's name. + fulfillment_set_id: + type: string + title: fulfillment_set_id + description: The service zone's fulfillment set id. + geo_zones: + type: array + description: The service zone's geo zones. + items: + $ref: ./AdminGeoZone.yaml + shipping_options: + type: array + description: The service zone's shipping options. + items: + $ref: ./AdminShippingOption.yaml + created_at: + type: string + format: date-time + title: created_at + description: The service zone's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The service zone's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The service zone's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml new file mode 100644 index 0000000000..dd8ff8c8d1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminServiceZoneResponse +required: + - service_zone +properties: + service_zone: + $ref: ./AdminServiceZone.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml new file mode 100644 index 0000000000..219dac6bdc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's shipping options. +x-schemaName: AdminShippingOption diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml new file mode 100644 index 0000000000..4581ba2a6a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingOptionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The shipping option's ID. + object: + type: string + title: object + description: The shipping option's object. + default: shipping_option + deleted: + type: boolean + title: deleted + description: The shipping option's deleted. + parent: + type: object + description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml new file mode 100644 index 0000000000..dba509d7fd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingOptionResponse +required: + - shipping_option +properties: + shipping_option: + $ref: ./AdminShippingOption.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml new file mode 100644 index 0000000000..29549d5ff2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's shipping profile. +x-schemaName: AdminShippingProfile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml new file mode 100644 index 0000000000..edbadf9d4d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingProfileDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The shipping profile's ID. + object: + type: string + title: object + description: The shipping profile's object. + default: shipping_profile + deleted: + type: boolean + title: deleted + description: The shipping profile's deleted. + parent: + type: object + description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml new file mode 100644 index 0000000000..ce83a08372 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingProfileResponse +required: + - shipping_profile +properties: + shipping_profile: + $ref: ./AdminShippingProfile.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml similarity index 70% rename from www/apps/api-reference/specs/store/components/schemas/UpdateApiKey.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml index 8587ad9fe0..1858893589 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateApiKey.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml @@ -1,6 +1,8 @@ type: object description: SUMMARY -x-schemaName: UpdateApiKey +x-schemaName: AdminUpdateApiKey +required: + - title properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCampaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml similarity index 77% rename from www/apps/api-reference/specs/admin/components/schemas/CreateCampaign.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml index 46bc1b1324..68b337aeb7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCampaign.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCampaign.yaml @@ -1,9 +1,8 @@ type: object -description: The promotion's campaign. -x-schemaName: CreateCampaign +description: SUMMARY +x-schemaName: AdminUpdateCampaign required: - - name - - campaign_identifier + - description - starts_at - ends_at properties: @@ -11,18 +10,22 @@ properties: type: string title: name description: The campaign's name. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. campaign_identifier: type: string title: campaign_identifier description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + properties: + limit: + type: number + title: limit + description: The budget's limit. starts_at: type: string title: starts_at @@ -33,15 +36,12 @@ properties: title: ends_at description: The campaign's ends at. format: date-time - budget: - $ref: ./CreateCampaignBudget.yaml promotions: type: array description: The campaign's promotions. items: type: object description: The promotion's promotions. - x-schemaName: Promotion required: - id properties: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml new file mode 100644 index 0000000000..a1a589243a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml @@ -0,0 +1,17 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateCollection +required: + - metadata +properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml similarity index 82% rename from www/apps/api-reference/specs/admin/components/schemas/CustomerUpdatableFields.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml index 96735acdd0..81d0b149a0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CustomerUpdatableFields.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomer.yaml @@ -1,7 +1,19 @@ type: object description: SUMMARY -x-schemaName: CustomerUpdatableFields +x-schemaName: AdminUpdateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone + - metadata properties: + email: + type: string + title: email + description: The customer's email. + format: email company_name: type: string title: company_name @@ -14,11 +26,6 @@ properties: type: string title: last_name description: The customer's last name. - email: - type: string - title: email - description: The customer's email. - format: email phone: type: string title: phone @@ -26,4 +33,3 @@ properties: metadata: type: object description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml similarity index 74% rename from www/apps/api-reference/specs/store/components/schemas/CustomerGroupUpdatableFields.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml index 4040e71cc0..b8e6cbca87 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupUpdatableFields.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,6 +1,9 @@ type: object description: SUMMARY -x-schemaName: CustomerGroupUpdatableFields +x-schemaName: AdminUpdateCustomerGroup +required: + - name + - metadata properties: name: type: string @@ -9,4 +12,3 @@ properties: metadata: type: object description: The customer group's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml new file mode 100644 index 0000000000..f6929dd104 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdatePriceList +required: + - description + - starts_at + - ends_at +properties: + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml new file mode 100644 index 0000000000..b95015d041 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml @@ -0,0 +1,146 @@ +type: object +description: The update's details. +x-schemaName: AdminUpdateProduct +properties: + title: + type: string + title: title + description: The update's title. + subtitle: + type: string + title: subtitle + description: The update's subtitle. + description: + type: string + title: description + description: The update's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The update's is giftcard. + discountable: + type: boolean + title: discountable + description: The update's discountable. + images: + type: array + description: The update's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The update's thumbnail. + handle: + type: string + title: handle + description: The update's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The update's type id. + collection_id: + type: string + title: collection_id + description: The update's collection id. + categories: + type: array + description: The update's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The update's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The update's options. + items: + $ref: ./AdminUpdateProductOption.yaml + variants: + type: array + description: The update's variants. + items: + $ref: ./AdminCreateProductVariant.yaml + sales_channels: + type: array + description: The update's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml new file mode 100644 index 0000000000..bfdca1a5cb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateProductOption +properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml new file mode 100644 index 0000000000..c0429b85e9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml @@ -0,0 +1,79 @@ +type: object +description: The update's details. +x-schemaName: AdminUpdateProductVariant +properties: + title: + type: string + title: title + description: The update's title. + sku: + type: string + title: sku + description: The update's sku. + ean: + type: string + title: ean + description: The update's ean. + upc: + type: string + title: upc + description: The update's upc. + barcode: + type: string + title: barcode + description: The update's barcode. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The update's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The update's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The update's variant rank. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + prices: + type: array + description: The update's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The update's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml new file mode 100644 index 0000000000..fb9b87db05 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateSalesChannel +required: + - description + - metadata +properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml new file mode 100644 index 0000000000..79f40f4276 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -0,0 +1,63 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateStockLocation +required: + - address_id + - metadata +properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml new file mode 100644 index 0000000000..6a0aa16f40 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml @@ -0,0 +1,46 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateStore +required: + - name + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata +properties: + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + type: object + description: The supported currency's supported currencies. + required: + - currency_code + properties: + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml new file mode 100644 index 0000000000..67e66e7550 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -0,0 +1,47 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateTaxRate +required: + - metadata +properties: + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + rules: + type: array + description: The tax rate's rules. + items: + type: object + description: The rule's rules. + required: + - reference + - reference_id + properties: + reference: + type: string + title: reference + description: The rule's reference. + reference_id: + type: string + title: reference_id + description: The rule's reference id. + name: + type: string + title: name + description: The tax rate's name. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + metadata: + type: object + description: The tax rate's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml similarity index 85% rename from www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index cf5247c937..781812e182 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -1,7 +1,9 @@ type: object description: SUMMARY -x-schemaName: AdminUpdateUserRequest +x-schemaName: AdminUpdateUser required: + - first_name + - last_name - avatar_url properties: first_name: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml new file mode 100644 index 0000000000..8db01d8c4c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateVariantInventoryItem +required: + - required_quantity +properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethod.yaml deleted file mode 100644 index 601d73f3a5..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethod.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: ApplicationMethod -properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml deleted file mode 100644 index d9798e4e3c..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml +++ /dev/null @@ -1,83 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: ApplicationMethodsMethodPostReq -properties: - description: - type: string - title: description - description: The application method's description. - value: - type: string - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - type: {} - target_type: {} - allocation: {} - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml new file mode 100644 index 0000000000..19efac7da2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml @@ -0,0 +1,3 @@ +type: object +description: The product's collection. +x-schemaName: BaseCollection diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml new file mode 100644 index 0000000000..97d46ce957 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml @@ -0,0 +1,3 @@ +type: object +description: The customer's customers. +x-schemaName: BaseCustomer diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml new file mode 100644 index 0000000000..b5f75c39e6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The address's addresses. +x-schemaName: BaseCustomerAddress +required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The address's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The address's is default billing. + customer_id: + type: string + title: customer_id + description: The address's customer id. + company: + type: string + title: company + description: The address's company. + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + phone: + type: string + title: phone + description: The address's phone. + metadata: + type: object + description: The address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml new file mode 100644 index 0000000000..5daa766350 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -0,0 +1,162 @@ +type: object +description: The updated's product. +x-schemaName: BaseProduct +required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - tags + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + $ref: ./BaseCollection.yaml + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + $ref: ./BaseProductCategory.yaml + type: + type: object + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: ./BaseProductTag.yaml + variants: + type: array + description: The product's variants. + items: + $ref: ./BaseProductVariant.yaml + options: + type: array + description: The product's options. + items: + $ref: ./BaseProductOption.yaml + images: + type: array + description: The product's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml new file mode 100644 index 0000000000..8bb7bdbaca --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml @@ -0,0 +1,3 @@ +type: object +description: The category's categories. +x-schemaName: BaseProductCategory diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml new file mode 100644 index 0000000000..cbabec4609 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml @@ -0,0 +1,3 @@ +type: object +description: The image's images. +x-schemaName: BaseProductImage diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml new file mode 100644 index 0000000000..91105a54c2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml @@ -0,0 +1,3 @@ +type: object +description: The option's options. +x-schemaName: BaseProductOption diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml new file mode 100644 index 0000000000..a607fba792 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The option's options. +x-schemaName: BaseProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The option's ID. + value: + type: string + title: value + description: The option's value. + option: + $ref: ./BaseProductOption.yaml + option_id: + type: string + title: option_id + description: The option's option id. + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml new file mode 100644 index 0000000000..eeff43fa01 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml @@ -0,0 +1,3 @@ +type: object +description: The tag's tags. +x-schemaName: BaseProductTag diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml new file mode 100644 index 0000000000..559318d70e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml @@ -0,0 +1,3 @@ +type: object +description: The variant's variants. +x-schemaName: BaseProductVariant diff --git a/www/apps/api-reference/specs/admin/components/schemas/Campaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/Campaign.yaml deleted file mode 100644 index 4bb9a968c6..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/Campaign.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: The promotion's campaign. -x-schemaName: Campaign -properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CampaignBudget.yaml b/www/apps/api-reference/specs/admin/components/schemas/CampaignBudget.yaml deleted file mode 100644 index cbd6c8f33d..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CampaignBudget.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: object -description: The campaign's budget. -x-schemaName: CampaignBudget -properties: - type: {} - limit: - type: number - title: limit - description: The budget's limit. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml index 93c6c488a6..5217a9aa3b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml @@ -49,4 +49,3 @@ properties: metadata: type: object description: The shipping address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateApplicationMethod.yaml deleted file mode 100644 index 72de305f09..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateApplicationMethod.yaml +++ /dev/null @@ -1,161 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: CreateApplicationMethod -required: - - type - - target_type -properties: - type: - type: string - enum: - - fixed - - percentage - target_type: - type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - value: - type: number - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - promotion: - oneOf: - - type: string - title: promotion - description: The application method's promotion. - - type: object - description: The application method's promotion. - x-schemaName: Promotion - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - code: - type: string - title: code - description: The promotion's code. - type: - type: string - enum: - - standard - - buyget - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - application_method: - $ref: ./ApplicationMethod.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - properties: {} - campaign: - $ref: ./Campaign.yaml - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCampaignBudget.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCampaignBudget.yaml deleted file mode 100644 index 4cb70d2da0..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCampaignBudget.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: The campaign's budget. -x-schemaName: CreateCampaignBudget -required: - - type - - limit -properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - used: - type: number - title: used - description: The budget's used. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml index 451a791dc5..ea5d127dd2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml @@ -45,4 +45,3 @@ properties: metadata: type: object description: The billing address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml index 6dad09e055..fc4ffc2354 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml @@ -6,7 +6,7 @@ required: - variant_id properties: quantity: - type: number + type: string title: quantity description: The item's quantity. variant_id: @@ -68,7 +68,6 @@ properties: variant_option_values: type: object description: The item's variant option values. - properties: {} requires_shipping: type: boolean title: requires_shipping @@ -86,18 +85,13 @@ properties: title: is_giftcard description: The item's is giftcard. compare_at_unit_price: - type: number + type: string title: compare_at_unit_price description: The item's compare at unit price. unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. + type: string + title: unit_price + description: The item's unit price. metadata: type: object description: The item's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml index 8739f0e9f8..369ef9b3a1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml @@ -36,218 +36,21 @@ properties: - type: string title: shipping_address description: The cart's shipping address. - - type: object - description: The cart's shipping address. - x-schemaName: CreateCartAddress - properties: - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - phone: - type: string - title: phone - description: The shipping address's phone. - company: - type: string - title: company - description: The shipping address's company. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - metadata: - type: object - description: The shipping address's metadata. - properties: {} + - $ref: ./CreateCartAddress.yaml billing_address: oneOf: - type: string title: billing_address description: The cart's billing address. - - type: object - description: The cart's billing address. - x-schemaName: CreateCartAddress - properties: - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - properties: {} + - $ref: ./CreateCartAddress.yaml metadata: type: object description: The cart's metadata. - properties: {} items: type: array description: The cart's items. items: - type: object - description: The item's items. - x-schemaName: CreateCartCreateLineItem - required: - - quantity - - variant_id - properties: - quantity: - type: number - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant id. - title: - type: string - title: title - description: The item's title. - subtitle: - type: string - title: subtitle - description: The item's subtitle. - thumbnail: - type: string - title: thumbnail - description: The item's thumbnail. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - properties: {} - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. - metadata: - type: object - description: The item's metadata. - properties: {} + $ref: ./CreateCartCreateLineItem.yaml promo_codes: type: array description: The cart's promo codes. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCustomer.yaml deleted file mode 100644 index 2d3dc8e709..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomer.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateCustomer -properties: - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - email: - type: string - title: email - description: The customer's email. - format: email - phone: - type: string - title: phone - description: The customer's phone. - created_by: - type: string - title: created_by - description: The customer's created by. - addresses: - type: array - description: The customer's addresses. - items: - type: object - description: The address's addresses. - x-schemaName: CreateCustomerAddress - properties: - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - properties: {} - metadata: - type: object - description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateDefaultTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateDefaultTaxRate.yaml deleted file mode 100644 index c6c96103fd..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateDefaultTaxRate.yaml +++ /dev/null @@ -1,22 +0,0 @@ -type: object -description: The tax region's default tax rate. -x-schemaName: CreateDefaultTaxRate -required: - - name -properties: - rate: - type: number - title: rate - description: The default tax rate's rate. - code: - type: string - title: code - description: The default tax rate's code. - name: - type: string - title: name - description: The default tax rate's name. - metadata: - type: object - description: The default tax rate's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateInvite.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateInvite.yaml deleted file mode 100644 index 3bd337893f..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateInvite.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateInvite -required: - - email -properties: - email: - type: string - title: email - description: The invite's email. - format: email - accepted: - type: boolean - title: accepted - description: The invite's accepted. - metadata: - type: object - description: The invite's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml new file mode 100644 index 0000000000..efbb641c2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: CreateOrderReturnReason +required: + - value + - label +properties: + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProduct.yaml deleted file mode 100644 index 16abcfdd21..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProduct.yaml +++ /dev/null @@ -1,256 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProduct -required: - - title -properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - oneOf: - - type: array - description: The product's images. - items: - type: string - title: images - description: The image's images. - - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - id: - type: string - title: id - description: The image's ID. - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type: - $ref: ./CreateProductType.yaml - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - x-schemaName: CreateProductTag - required: - - value - properties: - value: - type: string - title: value - description: The tag's value. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductOption - required: - - title - properties: - title: - type: string - title: title - description: The option's title. - product_id: - type: string - title: product_id - description: The option's product id. - variants: - type: array - description: The product's variants. - items: - type: object - description: The variant's variants. - x-schemaName: CreateProductVariant - required: - - title - properties: - product_id: - type: string - title: product_id - description: The variant's product id. - title: - type: string - title: title - description: The variant's title. - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The variant's metadata. - properties: {} - width: - type: number - title: width - description: The product's width. - height: - type: number - title: height - description: The product's height. - length: - type: number - title: length - description: The product's length. - weight: - type: number - title: weight - description: The product's weight. - origin_country: - type: string - title: origin_country - description: The product's origin country. - hs_code: - type: string - title: hs_code - description: The product's hs code. - material: - type: string - title: material - description: The product's material. - mid_code: - type: string - title: mid_code - description: The product's mid code. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductOption.yaml deleted file mode 100644 index d0bdb74b07..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductOption.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProductOption -required: - - title -properties: - title: - type: string - title: title - description: The product's title. - product_id: - type: string - title: product_id - description: The product's product id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductTag.yaml deleted file mode 100644 index e3f438c37b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductTag.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The tag's tags. -x-schemaName: CreateProductTag -required: - - value -properties: - value: - type: string - title: value - description: The tag's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductType.yaml deleted file mode 100644 index 9e0d11fe46..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductType.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: The product's type. -x-schemaName: CreateProductType -required: - - value -properties: - id: - type: string - title: id - description: The type's ID. - value: - type: string - title: value - description: The type's value. - metadata: - type: object - description: The type's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariant.yaml deleted file mode 100644 index 0ee0493162..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariant.yaml +++ /dev/null @@ -1,96 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProductVariant -required: - - title -properties: - product_id: - type: string - title: product_id - description: The product's product id. - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - barcode: - type: string - title: barcode - description: The product's barcode. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The product's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - hs_code: - type: string - title: hs_code - description: The product's hs code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariantOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariantOption.yaml deleted file mode 100644 index 0e6a3cc9cd..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariantOption.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -description: The option's options. -x-schemaName: CreateProductVariantOption -required: - - value -properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreatePromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreatePromotion.yaml deleted file mode 100644 index a6682edf44..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreatePromotion.yaml +++ /dev/null @@ -1,69 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreatePromotion -required: - - code - - type -properties: - code: - type: string - title: code - description: The promotion's code. - type: - type: string - enum: - - standard - - buyget - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - application_method: - $ref: ./CreateApplicationMethod.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - campaign: - $ref: ./CreateCampaign.yaml - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreatePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreatePromotionRule.yaml deleted file mode 100644 index 71dece3435..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreatePromotionRule.yaml +++ /dev/null @@ -1,37 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: CreatePromotionRule -required: - - attribute - - operator - - values -properties: - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateRegion.yaml deleted file mode 100644 index 7e4f392265..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateRegion.yaml +++ /dev/null @@ -1,26 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateRegion -required: - - name - - currency_code -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. - metadata: - type: object - description: The region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateTaxRateRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateTaxRateRule.yaml deleted file mode 100644 index ca8c3e1e3c..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateTaxRateRule.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: CreateTaxRateRule -required: - - reference - - reference_id -properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml index 13ef7578ba..3dfd4dcddb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml @@ -24,4 +24,3 @@ properties: metadata: type: object description: The user's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerAddress.yaml deleted file mode 100644 index b27d2dfb61..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CustomerAddress.yaml +++ /dev/null @@ -1,76 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CustomerAddress -properties: - id: - type: string - title: id - description: The customer's ID. - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - customer_id: - type: string - title: customer_id - description: The customer's customer id. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. - properties: {} - created_at: - type: string - title: created_at - description: The customer's created at. - updated_at: - type: string - title: updated_at - description: The customer's updated at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupsBatchCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupsBatchCustomer.yaml deleted file mode 100644 index 66fb19179a..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupsBatchCustomer.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The customer id's customer ids. -x-schemaName: CustomerGroupsBatchCustomer -required: - - id -properties: - id: - type: string - title: id - description: The customer id's ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/IdObject.yaml b/www/apps/api-reference/specs/admin/components/schemas/IdObject.yaml deleted file mode 100644 index b7ccb55d49..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/IdObject.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The promotion's promotions. -x-schemaName: IdObject -required: - - id -properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/MultipleErrors.yaml b/www/apps/api-reference/specs/admin/components/schemas/MultipleErrors.yaml deleted file mode 100644 index 7ca18cda3b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/MultipleErrors.yaml +++ /dev/null @@ -1,13 +0,0 @@ -title: Multiple Errors -type: object -properties: - errors: - type: array - description: Array of errors - items: - $ref: ./Error.yaml - message: - type: string - default: >- - Provided request body contains errors. Please check the data and retry the - request diff --git a/www/apps/api-reference/specs/admin/components/schemas/Promotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/Promotion.yaml deleted file mode 100644 index 7efc28f3cc..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/Promotion.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The promotion's promotions. -x-schemaName: Promotion -required: - - id -properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/admin/components/schemas/PromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/PromotionRule.yaml deleted file mode 100644 index b84cc3a668..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/PromotionRule.yaml +++ /dev/null @@ -1,33 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: PromotionRule -required: - - operator - - attribute - - values -properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddress.yaml deleted file mode 100644 index e5f134ac92..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddress.yaml +++ /dev/null @@ -1,39 +0,0 @@ -type: object -description: The stock location's address. -x-schemaName: StockLocationAddress -required: - - address_1 - - country_code -properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml new file mode 100644 index 0000000000..abf0714b02 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml @@ -0,0 +1,19 @@ +type: object +description: SUMMARY +x-schemaName: StoreAddCartLineItem +required: + - variant_id + - quantity + - metadata +properties: + variant_id: + type: string + title: variant_id + description: The cart's variant id. + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml new file mode 100644 index 0000000000..729f1b95bd --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCalculateCartTaxes +properties: + fields: + type: string + title: fields + description: The cart's fields. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml new file mode 100644 index 0000000000..07e7bc885c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +x-schemaName: StoreCreateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone +properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePostCartsCartTaxesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostCartsCartTaxesReq.yaml deleted file mode 100644 index 11c9ef8037..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePostCartsCartTaxesReq.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostCartsCartTaxesReq -properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml deleted file mode 100644 index 6163812d67..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostPaymentCollectionsPaymentSessionReq -required: - - provider_id -properties: - provider_id: - type: string - title: provider_id - description: The payment collection's provider id. - context: {} - data: - type: object - description: The payment collection's data. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml new file mode 100644 index 0000000000..3ab63409b6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePostReturnsReqSchema.yaml @@ -0,0 +1,68 @@ +type: object +description: SUMMARY +x-schemaName: StorePostReturnsReqSchema +required: + - order_id + - items + - return_shipping + - note + - location_id +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml new file mode 100644 index 0000000000..73ed56e5b1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -0,0 +1,162 @@ +type: object +description: The product's products. +x-schemaName: StoreProduct +required: + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - variants + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id +properties: + categories: + type: array + description: The product's categories. + items: + type: object + type: + type: object + title: + type: string + title: title + description: The product's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The product's length. + options: + type: array + description: The product's options. + items: + $ref: ./BaseProductOption.yaml + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + handle: + type: string + title: handle + description: The product's handle. + metadata: + type: object + description: The product's metadata. + hs_code: + type: string + title: hs_code + description: The product's hs code. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + variants: + type: array + description: The product's variants. + items: + $ref: ./BaseProductVariant.yaml + subtitle: + type: string + title: subtitle + description: The product's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + collection: + $ref: ./BaseCollection.yaml + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: ./BaseProductTag.yaml + images: + type: array + description: The product's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml new file mode 100644 index 0000000000..5f98dcd652 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml @@ -0,0 +1,77 @@ +type: object +description: The product category's details. +x-schemaName: StoreProductCategory +required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at +properties: + products: + type: array + description: The product category's products. + items: + $ref: ./StoreProduct.yaml + id: + type: string + title: id + description: The product category's ID. + 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_active: + type: boolean + title: is_active + description: The product category's is active. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + rank: + type: number + title: rank + description: The product category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The product category's parent category id. + parent_category: + $ref: ./BaseProductCategory.yaml + category_children: + type: array + description: The product category's category children. + items: + $ref: ./BaseProductCategory.yaml + created_at: + type: string + format: date-time + title: created_at + description: The product category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product category's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml new file mode 100644 index 0000000000..0b9eedfe4f --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductCategoryListResponse +required: + - limit + - offset + - count + - product_categories +properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml new file mode 100644 index 0000000000..05dc39f824 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductCategoryResponse +required: + - product_category +properties: + product_category: + $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml new file mode 100644 index 0000000000..e7c6862965 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: StoreUpdateCartLineItem +required: + - quantity + - metadata +properties: + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml new file mode 100644 index 0000000000..f9c3b19ebb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: StoreUpdateCustomer +required: + - company_name + - first_name + - last_name + - phone +properties: + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml index 13c364983d..0338cc6658 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml @@ -55,4 +55,3 @@ properties: metadata: type: object description: The shipping address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml index 2165e1e45b..0b29d94268 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml @@ -33,229 +33,12 @@ properties: description: The cart's billing address id. billing_address: oneOf: - - type: object - description: The cart's billing address. - x-schemaName: CreateAddress - properties: - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - company: - type: string - title: company - description: The billing address's company. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - phone: - type: string - title: phone - description: The billing address's phone. - metadata: - type: object - description: The billing address's metadata. - properties: {} - - type: object - description: The cart's billing address. - x-schemaName: UpdateAddress - required: - - id - properties: - id: - type: string - title: id - description: The billing address's ID. - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - company: - type: string - title: company - description: The billing address's company. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - phone: - type: string - title: phone - description: The billing address's phone. - metadata: - type: object - description: The billing address's metadata. - properties: {} + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml shipping_address: oneOf: - - type: object - description: The cart's shipping address. - x-schemaName: CreateAddress - properties: - customer_id: - type: string - title: customer_id - description: The shipping address's customer id. - company: - type: string - title: company - description: The shipping address's company. - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - phone: - type: string - title: phone - description: The shipping address's phone. - metadata: - type: object - description: The shipping address's metadata. - properties: {} - - type: object - description: The cart's shipping address. - x-schemaName: UpdateAddress - required: - - id - properties: - id: - type: string - title: id - description: The shipping address's ID. - customer_id: - type: string - title: customer_id - description: The shipping address's customer id. - company: - type: string - title: company - description: The shipping address's company. - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - phone: - type: string - title: phone - description: The shipping address's phone. - metadata: - type: object - description: The shipping address's metadata. - properties: {} + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml metadata: type: object description: The cart's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml new file mode 100644 index 0000000000..581ad731dc --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: UpdateOrderReturnReason +properties: + id: + type: string + title: id + description: The return reason's ID. + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProduct.yaml deleted file mode 100644 index d846bae03c..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateProduct.yaml +++ /dev/null @@ -1,271 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProduct -properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - oneOf: - - type: array - description: The product's images. - items: - type: string - title: images - description: The image's images. - - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - id: - type: string - title: id - description: The image's ID. - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type: - $ref: ./CreateProductType.yaml - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - x-schemaName: CreateProductTag - required: - - value - properties: - value: - type: string - title: value - description: The tag's value. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductOption - required: - - title - properties: - title: - type: string - title: title - description: The option's title. - product_id: - type: string - title: product_id - description: The option's product id. - variants: - type: array - description: The product's variants. - items: - type: object - description: The variant's variants. - x-schemaName: UpsertProductVariant - required: - - title - - metadata - - sku - - barcode - - ean - - upc - - allow_backorder - - inventory_quantity - - manage_inventory - - hs_code - - origin_country - - mid_code - - material - - weight - - length - - height - - width - - options - properties: - id: - type: string - title: id - description: The variant's ID. - title: - type: string - title: title - description: The variant's title. - metadata: - type: object - description: The variant's metadata. - properties: {} - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - width: - type: number - title: width - description: The product's width. - height: - type: number - title: height - description: The product's height. - length: - type: number - title: length - description: The product's length. - weight: - type: number - title: weight - description: The product's weight. - origin_country: - type: string - title: origin_country - description: The product's origin country. - hs_code: - type: string - title: hs_code - description: The product's hs code. - material: - type: string - title: material - description: The product's material. - mid_code: - type: string - title: mid_code - description: The product's mid code. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductCollection.yaml deleted file mode 100644 index 603135d317..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductCollection.yaml +++ /dev/null @@ -1,27 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductCollection -properties: - value: - type: string - title: value - description: The collection's value. - title: - type: string - title: title - description: The collection's title. - handle: - type: string - title: handle - description: The collection's handle. - product_ids: - type: array - description: The collection's product ids. - items: - type: string - title: product_ids - description: The product id's product ids. - metadata: - type: object - description: The collection's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductOption.yaml deleted file mode 100644 index b01b1af91b..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductOption.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductOption -required: - - id -properties: - id: - type: string - title: id - description: The product's ID. - title: - type: string - title: title - description: The product's title. - product_id: - type: string - title: product_id - description: The product's product id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductVariant.yaml deleted file mode 100644 index 23eba47ad6..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateProductVariant.yaml +++ /dev/null @@ -1,96 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductVariant -required: - - id -properties: - id: - type: string - title: id - description: The product's ID. - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - barcode: - type: string - title: barcode - description: The product's barcode. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The product's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - hs_code: - type: string - title: hs_code - description: The product's hs code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateRegion.yaml deleted file mode 100644 index 73c97adabc..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateRegion.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateRegion -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. - metadata: - type: object - description: The region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpsertProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpsertProductVariant.yaml deleted file mode 100644 index 53dbabc509..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/UpsertProductVariant.yaml +++ /dev/null @@ -1,113 +0,0 @@ -type: object -description: The variant's variants. -x-schemaName: UpsertProductVariant -required: - - title - - metadata - - sku - - barcode - - ean - - upc - - allow_backorder - - inventory_quantity - - manage_inventory - - hs_code - - origin_country - - mid_code - - material - - weight - - length - - height - - width - - options -properties: - id: - type: string - title: id - description: The variant's ID. - title: - type: string - title: title - description: The variant's title. - metadata: - type: object - description: The variant's metadata. - properties: {} - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index bdf80faa33..8eff5aaf88 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -12,6 +12,8 @@ tags: - name: Api Keys - name: Campaigns - name: Collections + x-associatedSchema: + $ref: '#/components/schemas/AdminCollection' - name: Currencies description: | A store can use unlimited currencies, and each region must be associated with at least one currency. @@ -20,47 +22,42 @@ tags: description: How to manage currencies url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies - name: Customer Groups - description: | - Customer Groups can be used to organize customers that share similar data or attributes into dedicated groups. - This can be useful for different purposes such as setting a different price for a specific customer group. - externalDocs: - description: How to manage customer groups - url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups + x-associatedSchema: + $ref: '#/components/schemas/AdminCustomerGroup' - name: Customers description: | Customers can either be created when they register through the Store APIs, or created by the admin using the Admin APIs. externalDocs: description: How to manage customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers - - name: Fulfillment + x-associatedSchema: + $ref: '#/components/schemas/AdminCustomer' + - name: Draft Orders + - name: Fulfillment Providers + x-associatedSchema: + $ref: '#/components/schemas/AdminFulfillmentProvider' + - name: Fulfillment Sets + x-associatedSchema: + $ref: '#/components/schemas/AdminFulfillmentSet' + - name: Fulfillments - name: Inventory Items - description: | - Inventory items, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), can be used to manage the inventory of saleable items in your store. - externalDocs: - description: How to manage inventory items - url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items - name: Invites description: | An admin can invite new users to manage their team. This would allow new users to authenticate as admins and perform admin functionalities. externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Orders - name: Payments - description: | - A payment can be related to an order, swap, return, or more. It can be captured or refunded. - name: Price Lists - description: | - A price list are special prices applied to products based on a set of conditions, such as customer group. - externalDocs: - description: How to manage price lists - url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - - name: Pricing + - name: Product Categories + x-associatedSchema: + $ref: '#/components/schemas/AdminProductCategory' + - name: Product Tags + - name: Product Types - name: Products - description: | - Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store. - externalDocs: - description: How to manage products - url: https://docs.medusajs.com/modules/products/admin/manage-products + x-associatedSchema: + $ref: '#/components/schemas/AdminProduct' - name: Promotions - name: Regions description: | @@ -69,6 +66,9 @@ tags: externalDocs: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + - name: Reservations + - name: Return Reasons + - name: Returns - name: Sales Channels description: | A sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app. @@ -76,21 +76,20 @@ tags: externalDocs: description: How to manage sales channels url: https://docs.medusajs.com/modules/sales-channels/admin/manage + x-associatedSchema: + $ref: '#/components/schemas/AdminSalesChannel' + - name: Shipping Options + x-associatedSchema: + $ref: '#/components/schemas/AdminShippingOption' + - name: Shipping Profiles + x-associatedSchema: + $ref: '#/components/schemas/AdminShippingProfile' - name: Stock Locations - name: Stores - name: Tax Rates - description: | - Each region has at least a default tax rate. Admins can create and manage additional tax rates that can be applied for certain conditions, such as for specific product types. - externalDocs: - description: How to manage tax rates - url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates - name: Tax Regions + - name: Uploads - name: Users - description: | - A store can have more than one user, each having the same privileges. Admins can manage users, their passwords, and more. - externalDocs: - description: How to manage users - url: https://docs.medusajs.com/modules/users/admin/manage-users - name: Workflows Executions paths: /admin/api-keys: @@ -99,7 +98,53 @@ paths: 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. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -113,6 +158,8 @@ paths: tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -125,29 +172,83 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostApiKeys summary: Create Api Key description: Create a api key. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateApiKey' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}", + "type": "{value}" + }' tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -160,10 +261,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/api-keys/{id}: get: operationId: GetApiKeysId @@ -177,6 +274,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -190,6 +333,8 @@ paths: tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -202,10 +347,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostApiKeysId summary: Update a Api Key @@ -218,19 +359,76 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateApiKey' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/api-keys/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}" + }' tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -243,10 +441,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteApiKeysId summary: Delete a Api Key @@ -259,6 +453,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -272,6 +512,8 @@ paths: tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -284,10 +526,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/api-keys/{id}/revoke: post: operationId: PostApiKeysIdRevoke @@ -301,10 +539,61 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminRevokeApiKey' x-codeSamples: - lang: Shell label: cURL @@ -314,6 +603,8 @@ paths: tags: - Api Keys responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -326,17 +617,166 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/api-keys/{id}/sales-channels: + post: + operationId: PostApiKeysIdSalesChannels + summary: Add Sales Channels to Api Key + description: Add a list of sales channels to a api key. + x-authenticated: true + parameters: + - name: id + in: path + description: The api key's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The api key's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The api key's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/api-keys/{id}/sales-channels' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Api Keys + 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' /admin/campaigns: get: operationId: GetCampaigns summary: List Campaigns description: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -350,6 +790,8 @@ paths: tags: - Campaigns responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -362,29 +804,149 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCampaigns summary: Create Campaign description: Create a campaign. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/campaigns' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Gunner", + "campaign_identifier": "{value}", + "description": "{value}", + "starts_at": "2024-08-24T00:19:14.144Z", + "ends_at": "2024-10-01T06:47:50.133Z" + }' tags: - Campaigns responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -397,10 +959,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/campaigns/{id}: get: operationId: GetCampaignsId @@ -414,6 +972,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -427,6 +1031,8 @@ paths: tags: - Campaigns responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -439,10 +1045,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCampaignsId summary: Update a Campaign @@ -455,6 +1057,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -463,7 +1111,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostCampaignsReq' + $ref: '#/components/schemas/AdminUpdateCampaign' x-codeSamples: - lang: Shell label: cURL @@ -472,11 +1120,15 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Moriah" + "description": "{value}", + "starts_at": "2024-08-10T14:44:10.530Z", + "ends_at": "2024-07-13T17:45:37.462Z" }' tags: - Campaigns responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -501,6 +1153,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -514,6 +1212,8 @@ paths: tags: - Campaigns responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -526,17 +1226,166 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/campaigns/{id}/promotions: + post: + operationId: PostCampaignsIdPromotions + summary: Add Promotions to Campaign + description: Add a list of promotions to a campaign. + x-authenticated: true + parameters: + - name: id + in: path + description: The campaign's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The campaign's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The campaign's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/campaigns/{id}/promotions' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Campaigns + 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' /admin/collections: get: operationId: GetCollections summary: List Collections description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -550,6 +1399,8 @@ paths: tags: - Collections responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -562,29 +1413,83 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCollections summary: Create Collection description: Create a collection. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateCollection' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/collections' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}", + "metadata": {} + }' tags: - Collections responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -597,10 +1502,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/collections/{id}: get: operationId: GetCollectionsId @@ -614,6 +1515,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -627,6 +1574,8 @@ paths: tags: - Collections responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -639,10 +1588,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCollectionsId summary: Update a Collection @@ -655,19 +1600,76 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateCollection' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/collections/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' tags: - Collections responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -680,10 +1682,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCollectionsId summary: Delete a Collection @@ -696,6 +1694,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -709,6 +1753,8 @@ paths: tags: - Collections responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -721,17 +1767,166 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/collections/{id}/products: + post: + operationId: PostCollectionsIdProducts + summary: Add Products to Collection + description: Add a list of products to a collection. + x-authenticated: true + parameters: + - name: id + in: path + description: The collection's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The collection's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The collection's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/collections/{id}/products' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Collections + 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' /admin/currencies: get: operationId: GetCurrencies summary: List Currencies description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -745,6 +1940,8 @@ paths: tags: - Currencies responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -757,10 +1954,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/currencies/{code}: get: operationId: GetCurrenciesCode @@ -774,6 +1967,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -787,6 +2026,8 @@ paths: tags: - Currencies responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -799,17 +2040,59 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customer-groups: get: operationId: GetCustomerGroups summary: List Customer Groups description: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -823,6 +2106,8 @@ paths: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -835,29 +2120,83 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomerGroups summary: Create Customer Group description: Create a customer group. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateCustomerGroup' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customer-groups' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Solon", + "metadata": {} + }' tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -870,10 +2209,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customer-groups/{id}: get: operationId: GetCustomerGroupsId @@ -887,6 +2222,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -900,6 +2281,8 @@ paths: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -912,10 +2295,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomerGroupsId summary: Update a Customer Group @@ -928,19 +2307,77 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateCustomerGroup' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customer-groups/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Corbin", + "metadata": {} + }' tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -953,10 +2390,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomerGroupsId summary: Delete a Customer Group @@ -969,6 +2402,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -982,6 +2461,8 @@ paths: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -994,55 +2475,9 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customer-groups/{id}/customers: - get: - operationId: GetCustomerGroupsIdCustomers - summary: List Customers - description: Retrieve a list of customers in a customer group. The customers can be filtered by fields like FILTER FIELDS. The customers can also be paginated. - x-authenticated: true - parameters: - - name: id - in: path - description: The customer group's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl '{backend_url}/admin/customer-groups/{id}/customers' \ - -H 'x-medusa-access-token: {api_token}' - tags: - - Customer Groups - responses: - '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' - requestBody: - content: - application/json: - schema: {} - /admin/customer-groups/{id}/customers/batch: post: - operationId: PostCustomerGroupsIdCustomersBatch + operationId: PostCustomerGroupsIdCustomers summary: Add Customers to Customer Group description: Add a list of customers to a customer group. x-authenticated: true @@ -1053,57 +2488,52 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/batch' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "customer_ids": [ - { - "id": "id_dx2Wieq4uGG" - } - ] - }' - tags: - - Customer Groups - responses: - '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' - /admin/customer-groups/{id}/customers/remove: - post: - operationId: PostCustomerGroupsIdCustomersRemove - summary: Add Removes to Customer Group - description: Add a list of removes to a customer group. - x-authenticated: true - parameters: - - name: id - in: path - description: The customer group's ID. - required: true + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false schema: type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1112,24 +2542,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq' + type: object + description: SUMMARY + properties: + add: + type: array + description: The customer group's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The customer group's remove. + items: + type: string + title: remove + description: The remove's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/customer-groups/{id}/customers/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "customer_ids": [ - { - "id": "id_oAhMZi39hsjIOqPA6" - } - ] - }' + curl -X POST '{backend_url}/admin/customer-groups/{id}/customers' \ + -H 'x-medusa-access-token: {api_token}' tags: - Customer Groups responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1148,7 +2588,53 @@ paths: summary: List Customers description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1162,6 +2648,38 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + - type: object + description: SUMMARY + required: + - customers + properties: + customers: + $ref: '#/components/schemas/AdminCustomer' '400': $ref: '#/components/responses/400_error' '401': @@ -1174,29 +2692,97 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomers summary: Create Customer description: Create a customer. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateCustomer' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customers' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "email": "Tomas.Toy16@yahoo.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "metadata": {} + }' tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: '#/components/schemas/AdminCustomer' '400': $ref: '#/components/responses/400_error' '401': @@ -1209,10 +2795,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customers/{id}: get: operationId: GetCustomersId @@ -1226,6 +2808,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1239,6 +2867,18 @@ paths: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: '#/components/schemas/AdminCustomer' '400': $ref: '#/components/responses/400_error' '401': @@ -1251,10 +2891,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersId summary: Update a Customer @@ -1267,19 +2903,91 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateCustomer' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "email": "Daren_Rodriguez-Rutherford93@gmail.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "metadata": {} + }' tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: '#/components/schemas/AdminCustomer' '400': $ref: '#/components/responses/400_error' '401': @@ -1292,10 +3000,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersId summary: Delete a Customer @@ -1308,6 +3012,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1321,6 +3071,8 @@ paths: tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1333,10 +3085,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customers/{id}/addresses: get: operationId: GetCustomersIdAddresses @@ -1350,6 +3098,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1363,6 +3157,8 @@ paths: tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1375,10 +3171,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersIdAddresses summary: Add Addresses to Customer @@ -1391,19 +3183,87 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateCustomerAddress' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}/addresses' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "address_name": "{value}", + "company": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "phone": "{value}", + "metadata": {} + }' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1416,10 +3276,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/customers/{id}/addresses/{address_id}: get: operationId: GetCustomersIdAddressesAddress_id @@ -1439,6 +3295,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1452,6 +3354,8 @@ paths: tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1464,10 +3368,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersIdAddressesAddress_id summary: Add Addresses to Customer @@ -1486,19 +3386,87 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateCustomerAddress' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/customers/{id}/addresses/{address_id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "address_name": "{value}", + "company": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "phone": "{value}", + "metadata": {} + }' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1511,10 +3479,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersIdAddressesAddress_id summary: Remove Addresses from Customer @@ -1533,6 +3497,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1546,6 +3556,8 @@ paths: tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1558,23 +3570,138 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/fulfillment/shipping-options/{id}/rules/batch/add: - post: - operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd - summary: Add Adds to Fulfillment - description: Add a list of adds to a fulfillment. + /admin/draft-orders: + get: + operationId: GetDraftOrders + summary: List Draft Orders + description: Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated. x-authenticated: true parameters: - - name: id - in: path - description: The fulfillment's ID. - required: true + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false schema: type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/draft-orders' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostDraftOrders + summary: Create Draft Order + description: Create a draft order. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1583,73 +3710,1553 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq' + type: object + description: SUMMARY + required: + - sales_channel_id + - email + - customer_id + - region_id + - currency_code + - shipping_methods + - metadata + properties: + status: + type: boolean + title: status + description: The draft order's status. + sales_channel_id: + type: string + title: sales_channel_id + description: The draft order's sales channel id. + email: + type: string + title: email + description: The draft order's email. + format: email + customer_id: + type: string + title: customer_id + description: The draft order's customer id. + billing_address: + type: object + description: The draft order's billing address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + shipping_address: + type: object + description: The draft order's shipping address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + phone: + type: string + title: phone + description: The shipping address's phone. + company: + type: string + title: company + description: The shipping address's company. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + metadata: + type: object + description: The shipping address's metadata. + items: + type: array + description: The draft order's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - barcode + - variant_id + - unit_price + - quantity + - metadata + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + variant_id: + type: string + title: variant_id + description: The item's variant id. + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: object + description: The item's unit price. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The unit price's value. + precision: + type: number + title: precision + description: The unit price's precision. + quantity: + type: number + title: quantity + description: The item's quantity. + metadata: + type: object + description: The item's metadata. + region_id: + type: string + title: region_id + description: The draft order's region id. + promo_codes: + type: array + description: The draft order's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + currency_code: + type: string + title: currency_code + description: The draft order's currency code. + no_notification_order: + type: boolean + title: no_notification_order + description: The draft order's no notification order. + shipping_methods: + type: array + description: The draft order's shipping methods. + items: + type: object + description: The shipping method's shipping methods. + required: + - shipping_method_id + - order_id + - name + - option_id + - amount + properties: + shipping_method_id: + type: string + title: shipping_method_id + description: The shipping method's shipping method id. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + option_id: + type: string + title: option_id + description: The shipping method's option id. + data: + type: object + description: The shipping method's data. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: object + description: The shipping method's amount. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The amount's value. + precision: + type: number + title: precision + description: The amount's precision. + metadata: + type: object + description: The draft order's metadata. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/add' \ + curl -X POST '{backend_url}/admin/draft-orders' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "rules": [ + "sales_channel_id": "{value}", + "email": "Bartholome.Goodwin90@yahoo.com", + "customer_id": "{value}", + "region_id": "{value}", + "currency_code": "{value}", + "shipping_methods": [ { - "attribute": "{value}" + "shipping_method_id": "{value}", + "order_id": "{value}", + "name": "Cheyanne", + "option_id": "{value}" + } + ], + "metadata": {} + }' + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/draft-orders/{id}: + get: + operationId: GetDraftOrdersId + summary: Get a Draft Order + description: Retrieve a draft order by its ID. You can expand the draft order's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/draft-orders/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/fulfillment-providers: + get: + operationId: GetFulfillmentProviders + summary: List Fulfillment Providers + description: Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The fulfillment provider's ID. + - type: array + description: The fulfillment provider's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The fulfillment provider's is enabled. + required: true + schema: + type: boolean + title: is_enabled + description: The fulfillment provider's is enabled. + - name: q + in: query + description: The fulfillment provider's q. + required: false + schema: + type: string + title: q + description: The fulfillment provider's q. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/fulfillment-providers' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Fulfillment Providers + 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' + /admin/fulfillment-sets/{id}: + delete: + operationId: DeleteFulfillmentSetsId + summary: Delete a Fulfillment Set + description: Delete a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentSetDeleteResponse' + '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' + /admin/fulfillment-sets/{id}/service-zones: + post: + operationId: PostFulfillmentSetsIdServiceZones + summary: Add Service Zones to Fulfillment Set + description: Add a list of service zones to a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The fulfillment set's name. + geo_zones: + type: array + description: The fulfillment set's geo zones. + items: + oneOf: + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + - city + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + city: + type: string + title: city + description: The geo zone's city. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + - city + - postal_expression + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + city: + type: string + title: city + description: The geo zone's city. + postal_expression: + type: object + description: The geo zone's postal expression. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Layla" + }' + tags: + - Fulfillment Sets + 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' + /admin/fulfillment-sets/{id}/service-zones/{zone_id}: + get: + operationId: GetFulfillmentSetsIdServiceZonesZone_id + summary: List Service Zones + description: Retrieve a list of service zones in a fulfillment set. The service zones can be filtered by fields like FILTER FIELDS. The service zones can also be paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminServiceZoneResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostFulfillmentSetsIdServiceZonesZone_id + summary: Add Service Zones to Fulfillment Set + description: Add a list of service zones to a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The fulfillment set's name. + geo_zones: + type: array + description: The fulfillment set's geo zones. + items: + oneOf: + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - country_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - country_code + - province_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - city + - country_code + - province_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + city: + type: string + title: city + description: The geo zone's city. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - city + - country_code + - province_code + - postal_expression + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + city: + type: string + title: city + description: The geo zone's city. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + postal_expression: + type: object + description: The geo zone's postal expression. + id: + type: string + title: id + description: The geo zone's ID. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Elvis" + }' + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminFulfillmentSetResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteFulfillmentSetsIdServiceZonesZone_id + summary: Remove Service Zones from Fulfillment Set + description: Remove a list of service zones from a fulfillment set. This doesn't delete the Service Zone, only the association between the Service Zone and the fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Fulfillment Sets + 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' + /admin/fulfillments: + post: + operationId: PostFulfillments + summary: Create Fulfillment + description: Create a fulfillment. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateFulfillment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/fulfillments' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "location_id": "{value}", + "provider_id": "{value}", + "delivery_address": { + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "metadata": {} + }, + "items": [ + { + "title": "{value}", + "sku": "{value}", + "quantity": 1667318922870784, + "barcode": "{value}", + "line_item_id": "{value}", + "inventory_item_id": "{value}" + } + ], + "labels": [ + { + "tracking_number": "{value}", + "tracking_url": "{value}", + "label_url": "{value}" + } + ], + "order": {}, + "order_id": "{value}", + "shipping_option_id": "{value}", + "data": {}, + "packed_at": "2024-11-12T18:37:37.122Z", + "shipped_at": "2025-04-13T12:39:42.432Z", + "delivered_at": "2025-01-29T19:05:57.056Z", + "canceled_at": "2025-02-16T02:12:11.763Z", + "metadata": {} + }' + tags: + - Fulfillments + 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' + /admin/fulfillments/{id}/cancel: + post: + operationId: PostFulfillmentsIdCancel + summary: Add Cancels to Fulfillment + description: Add a list of cancels to a fulfillment. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCancelFulfillment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/fulfillments/{id}/cancel' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Fulfillments + 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' + /admin/fulfillments/{id}/shipment: + post: + operationId: PostFulfillmentsIdShipment + summary: Add Shipments to Fulfillment + description: Add a list of shipments to a fulfillment. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateShipment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/fulfillments/{id}/shipment' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "labels": [ + { + "tracking_number": "{value}", + "tracking_url": "{value}", + "label_url": "{value}" } ] }' tags: - - Fulfillment - responses: - '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' - /admin/fulfillment/shipping-options/{id}/rules/batch/remove: - post: - operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove - summary: Add Removes to Fulfillment - description: Add a list of removes to a fulfillment. - x-authenticated: true - parameters: - - name: id - in: path - description: The fulfillment's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/fulfillment/shipping-options/{id}/rules/batch/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rule_ids": [ - "{value}" - ] - }' - tags: - - Fulfillment + - Fulfillments responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1668,7 +5275,312 @@ paths: summary: List Inventory Items description: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The inventory item's q. + required: false + schema: + type: string + title: q + description: The inventory item's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The inventory item's ID. + - type: array + description: The inventory item's ID. + items: + type: string + title: id + description: The id's ID. + - name: sku + in: query + required: false + schema: + oneOf: + - type: string + title: sku + description: The inventory item's sku. + - type: array + description: The inventory item's sku. + items: + type: string + title: sku + description: The sku's details. + - name: origin_country + in: query + required: false + schema: + oneOf: + - type: string + title: origin_country + description: The inventory item's origin country. + - type: array + description: The inventory item's origin country. + items: + type: string + title: origin_country + description: The origin country's details. + - name: mid_code + in: query + required: false + schema: + oneOf: + - type: string + title: mid_code + description: The inventory item's mid code. + - type: array + description: The inventory item's mid code. + items: + type: string + title: mid_code + description: The mid code's details. + - name: hs_code + in: query + required: false + schema: + oneOf: + - type: string + title: hs_code + description: The inventory item's hs code. + - type: array + description: The inventory item's hs code. + items: + type: string + title: hs_code + description: The hs code's details. + - name: material + in: query + required: false + schema: + oneOf: + - type: string + title: material + description: The inventory item's material. + - type: array + description: The inventory item's material. + items: + type: string + title: material + description: The material's details. + - name: requires_shipping + in: query + description: The inventory item's requires shipping. + required: true + schema: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + - name: weight + in: query + description: The inventory item's weight. + required: false + schema: + type: object + description: The inventory item's weight. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: length + in: query + description: The inventory item's length. + required: false + schema: + type: object + description: The inventory item's length. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: height + in: query + description: The inventory item's height. + required: false + schema: + type: object + description: The inventory item's height. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: width + in: query + description: The inventory item's width. + required: false + schema: + type: object + description: The inventory item's width. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: location_levels + in: query + description: The inventory item's location levels. + required: false + schema: + type: object + description: The inventory item's location levels. + properties: + location_id: + oneOf: + - type: string + title: location_id + description: The location level's location id. + - type: array + description: The location level's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -1682,6 +5594,8 @@ paths: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1694,16 +5608,58 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostInventoryItems summary: Create Inventory Item description: Create a inventory item. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1712,16 +5668,126 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInventoryItemsReq' + 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. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "sku": "{value}", + "hs_code": "{value}", + "weight": 2857134683324416, + "length": 2322256963305472, + "height": 8391220613087232, + "width": 1297863250280448, + "origin_country": "{value}", + "mid_code": "{value}", + "material": "{value}", + "title": "{value}", + "description": "{value}", + "thumbnail": "{value}", + "metadata": {} + }' tags: - Inventory Items responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1747,6 +5813,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1760,6 +5872,8 @@ paths: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1772,10 +5886,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostInventoryItemsId summary: Update a Inventory Item @@ -1788,6 +5898,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1796,13 +5952,100 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInventoryItemsInventoryItemReq' + 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. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/inventory-items/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "sku": "{value}", + "hs_code": "{value}", + "weight": 8979922215239680, + "length": 667491233693696, + "height": 6328111551479808, + "width": 7175104570064896, + "origin_country": "{value}", + "mid_code": "{value}", + "material": "{value}", + "title": "{value}", + "description": "{value}", + "thumbnail": "{value}", + "metadata": {} + }' tags: - Inventory Items responses: @@ -1832,6 +6075,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1845,6 +6134,8 @@ paths: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1857,11 +6148,114 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/inventory-items/{id}/location-levels: + get: + operationId: GetInventoryItemsIdLocationLevels + summary: List Location Levels + description: Retrieve a list of location levels in a inventory item. The location levels can be filtered by fields like FILTER FIELDS. The location levels can also be paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The inventory item's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The inventory item's location id. + - type: array + description: The inventory item's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/inventory-items/{id}/location-levels' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Inventory Items + 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' post: operationId: PostInventoryItemsIdLocationLevels summary: Add Location Levels to Inventory Item @@ -1874,6 +6268,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1882,7 +6322,23 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq' + type: object + description: SUMMARY + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The inventory item's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory item's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory item's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -1891,12 +6347,149 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "location_id": "{value}", - "stocked_quantity": 1506469662949376 + "location_id": "{value}" }' tags: - Inventory Items 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' + /admin/inventory-items/{id}/location-levels/batch: + post: + operationId: PostInventoryItemsIdLocationLevelsBatch + summary: Add Location Levels to Inventory Item + description: Add a list of location levels to a inventory item. + x-authenticated: true + parameters: + - name: id + in: path + description: The inventory item's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The inventory item's create. + items: + type: object + description: The create's details. + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The create's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The create's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The create's incoming quantity. + update: + type: array + description: The inventory item's update. + items: + type: object + description: The update's details. + properties: + stocked_quantity: + type: number + title: stocked_quantity + description: The update's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The update's incoming quantity. + delete: + type: array + description: The inventory item's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Inventory Items + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -1928,6 +6521,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1936,7 +6575,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq' + type: object + description: SUMMARY + properties: + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory item's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory item's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -1978,6 +6627,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1991,6 +6686,8 @@ paths: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2003,30 +6700,213 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/invites: get: operationId: GetInvites summary: List Invites description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The invite's q. + required: false + schema: + type: string + title: q + description: The invite's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The invite's ID. + - type: array + description: The invite's ID. + items: + type: string + title: id + description: The id's ID. + - name: email + in: query + required: false + schema: + oneOf: + - type: string + title: email + description: The invite's email. + format: email + - type: array + description: The invite's email. + items: + type: string + title: email + description: The email's details. + format: email + - name: created_at + in: query + description: The invite's created at. + required: false + schema: + type: object + description: The invite's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The invite's updated at. + required: false + schema: + type: object + description: The invite's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The invite's deleted at. + required: false + schema: + type: object + description: The invite's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} x-codeSamples: - lang: Shell label: cURL - source: |- - curl '{backend_url}/admin/invites' \ - -H 'x-medusa-access-token: {api_token}' + source: curl '{backend_url}/admin/invites' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2039,29 +6919,86 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostInvites summary: Create Invite description: Create a invite. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - email + properties: + email: + type: string + title: email + description: The invite's email. + format: email x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/invites' \ - -H 'x-medusa-access-token: {api_token}' + -H 'Content-Type: application/json' \ + --data-raw '{ + "email": "Whitney_Schultz@gmail.com" + }' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2074,40 +7011,99 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/invites/accept: post: operationId: PostInvitesAccept summary: Create Invite description: Create a invite. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: schema: - $ref: '#/components/schemas/AdminPostInvitesInviteAcceptReq' + type: object + description: SUMMARY + required: + - email + - first_name + - last_name + properties: + email: + type: string + title: email + description: The invite's email. + format: email + first_name: + type: string + title: first_name + description: The invite's first name. + last_name: + type: string + title: last_name + description: The invite's last name. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/invites/accept' \ - -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ + "email": "Lila_Zemlak@hotmail.com", "first_name": "{value}", "last_name": "{value}" }' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2125,7 +7121,7 @@ paths: operationId: GetInvitesId summary: Get a Invite description: Retrieve a invite by its ID. You can expand the invite's relations or select the fields that should be returned. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -2133,19 +7129,61 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: |- - curl '{backend_url}/admin/invites/{id}' \ - -H 'x-medusa-access-token: {api_token}' + source: curl '{backend_url}/admin/invites/{id}' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2158,15 +7196,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteInvitesId summary: Delete a Invite description: Delete a invite. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -2174,19 +7208,61 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/invites/{id}' \ - -H 'x-medusa-access-token: {api_token}' + source: curl -X DELETE '{backend_url}/admin/invites/{id}' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2199,16 +7275,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/invites/{id}/resend: post: operationId: PostInvitesIdResend summary: Add Resends to Invite description: Add a list of resends to a invite. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -2216,19 +7288,61 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X POST '{backend_url}/admin/invites/{id}/resend' \ - -H 'x-medusa-access-token: {api_token}' + source: curl -X POST '{backend_url}/admin/invites/{id}/resend' tags: - Invites responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2241,17 +7355,1035 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/orders: + get: + operationId: GetOrders + summary: List Orders + description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/orders' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}: + get: + operationId: GetOrdersId + summary: Get a Order + description: Retrieve a order by its ID. You can expand the order's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/orders/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostOrdersId + summary: Update a Order + description: Update a order's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/archive: + post: + operationId: PostOrdersIdArchive + summary: Add Archives to Order + description: Add a list of archives to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/AdminArchiveOrder' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/archive' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}" + }' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/cancel: + post: + operationId: PostOrdersIdCancel + summary: Add Cancels to Order + description: Add a list of cancels to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/cancel' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/complete: + post: + operationId: PostOrdersIdComplete + summary: Add Completes to Order + description: Add a list of completes to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCompleteOrder' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/complete' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}" + }' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/fulfillments: + post: + operationId: PostOrdersIdFulfillments + summary: Add Fulfillments to Order + description: Add a list of fulfillments to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderCreateFulfillment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/fulfillments' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "items": [ + { + "id": "id_YePfQ6PBCBKvmYyreUt2", + "quantity": 6623610359775232 + } + ], + "location_id": "{value}", + "metadata": {} + }' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: + post: + operationId: PostOrdersIdFulfillmentsFulfillment_idCancel + summary: Add Cancels to Order + description: Add a list of cancels to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The order's fulfillment id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderCancelFulfillment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/orders/{id}/fulfillments/{fulfillment_id}/shipment: + post: + operationId: PostOrdersIdFulfillmentsFulfillment_idShipment + summary: Add Shipments to Order + description: Add a list of shipments to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The order's fulfillment id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderCreateShipment' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "items": [ + { + "id": "id_eyih2debIPWMK4kaHGPZ", + "quantity": 7476297089417216 + } + ], + "metadata": {} + }' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/payments: get: operationId: GetPayments summary: List Payments description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The payment's q. + required: false + schema: + type: string + title: q + description: The payment's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment's ID. + - type: array + description: The payment's ID. + items: + type: string + title: id + description: The id's ID. + - name: payment_session_id + in: query + required: false + schema: + oneOf: + - type: string + title: payment_session_id + description: The payment's payment session id. + - type: array + description: The payment's payment session id. + items: + type: string + title: payment_session_id + description: The payment session id's details. + - name: created_at + in: query + description: The payment's created at. + required: false + schema: + type: object + description: The payment's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The payment's updated at. + required: false + schema: + type: object + description: The payment's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The payment's deleted at. + required: false + schema: + type: object + description: The payment's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -2265,6 +8397,118 @@ paths: tags: - Payments 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' + /admin/payments/payment-providers: + get: + operationId: GetPaymentsPaymentProviders + summary: List Payments + description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment's ID. + - type: array + description: The payment's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The payment's is enabled. + required: false + schema: + type: boolean + title: is_enabled + description: The payment's is enabled. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/payments/payment-providers' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Payments + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2277,10 +8521,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/payments/{id}: get: operationId: GetPaymentsId @@ -2294,6 +8534,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2307,6 +8593,8 @@ paths: tags: - Payments responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2319,10 +8607,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/payments/{id}/capture: post: operationId: PostPaymentsIdCapture @@ -2336,6 +8620,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2344,7 +8674,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPaymentsCapturesReq' + type: object + description: SUMMARY + properties: + amount: + type: number + title: amount + description: The payment's amount. x-codeSamples: - lang: Shell label: cURL @@ -2354,6 +8690,8 @@ paths: tags: - Payments responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2379,6 +8717,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2387,7 +8771,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPaymentsRefundsReq' + type: object + description: SUMMARY + properties: + amount: + type: number + title: amount + description: The payment's amount. x-codeSamples: - lang: Shell label: cURL @@ -2397,6 +8787,8 @@ paths: tags: - Payments responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2415,7 +8807,53 @@ paths: summary: List Price Lists description: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2429,6 +8867,8 @@ paths: tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2441,16 +8881,58 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostPriceLists summary: Create Price List description: Create a price list. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2459,7 +8941,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPriceListsReq' + $ref: '#/components/schemas/AdminCreatePriceList' x-codeSamples: - lang: Shell label: cURL @@ -2470,17 +8952,14 @@ paths: --data-raw '{ "title": "{value}", "description": "{value}", - "prices": [ - { - "currency_code": "{value}", - "amount": 1270314195484672, - "variant_id": "{value}" - } - ] + "starts_at": "{value}", + "ends_at": "{value}" }' tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2506,6 +8985,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2519,6 +9044,8 @@ paths: tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2531,10 +9058,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostPriceListsId summary: Update a Price List @@ -2547,6 +9070,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2555,7 +9124,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPriceListsPriceListReq' + $ref: '#/components/schemas/AdminUpdatePriceList' x-codeSamples: - lang: Shell label: cURL @@ -2564,17 +9133,15 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "prices": [ - { - "currency_code": "{value}", - "amount": 1670236243755008, - "variant_id": "{value}" - } - ] + "description": "{value}", + "starts_at": "{value}", + "ends_at": "{value}" }' tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2599,6 +9166,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2612,6 +9225,8 @@ paths: tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2624,15 +9239,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/price-lists/{id}/prices/batch/add: + /admin/price-lists/{id}/prices/batch: post: - operationId: PostPriceListsIdPricesBatchAdd - summary: Add Adds to Price List - description: Add a list of adds to a price list. + operationId: PostPriceListsIdPricesBatch + summary: Add Prices to Price List + description: Add a list of prices to a price list. x-authenticated: true parameters: - name: id @@ -2641,6 +9252,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2649,26 +9306,102 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq' + type: object + description: SUMMARY + properties: + create: + type: array + description: The price list's create. + items: + type: object + description: The create's details. + required: + - currency_code + - amount + - variant_id + - min_quantity + - max_quantity + properties: + currency_code: + type: string + title: currency_code + description: The create's currency code. + amount: + type: number + title: amount + description: The create's amount. + variant_id: + type: string + title: variant_id + description: The create's variant id. + min_quantity: + type: number + title: min_quantity + description: The create's min quantity. + max_quantity: + type: number + title: max_quantity + description: The create's max quantity. + rules: + type: object + description: The create's rules. + update: + type: array + description: The price list's update. + items: + type: object + description: The update's details. + required: + - id + - variant_id + - min_quantity + - max_quantity + properties: + id: + type: string + title: id + description: The update's ID. + currency_code: + type: string + title: currency_code + description: The update's currency code. + amount: + type: number + title: amount + description: The update's amount. + variant_id: + type: string + title: variant_id + description: The update's variant id. + min_quantity: + type: number + title: min_quantity + description: The update's min quantity. + max_quantity: + type: number + title: max_quantity + description: The update's max quantity. + rules: + type: object + description: The update's rules. + delete: + type: array + description: The price list's delete. + items: + type: string + title: delete + description: The delete's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/add' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "prices": [ - { - "currency_code": "{value}", - "amount": 6595965345595392, - "variant_id": "{value}" - } - ] - }' + curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ + -H 'x-medusa-access-token: {api_token}' tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2681,11 +9414,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/price-lists/{id}/prices/batch/remove: + /admin/price-lists/{id}/products: post: - operationId: PostPriceListsIdPricesBatchRemove - summary: Add Removes to Price List - description: Add a list of removes to a price list. + operationId: PostPriceListsIdProducts + summary: Add Products to Price List + description: Add a list of products to a price list. x-authenticated: true parameters: - name: id @@ -2694,6 +9427,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2702,22 +9481,34 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq' + type: object + description: SUMMARY + properties: + add: + type: array + description: The price list's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The price list's remove. + items: + type: string + title: remove + description: The remove's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "ids": [ - "{value}" - ] - }' + curl -X POST '{backend_url}/admin/price-lists/{id}/products' \ + -H 'x-medusa-access-token: {api_token}' tags: - Price Lists responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2730,31 +9521,281 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/pricing/rule-types: + /admin/product-categories: get: - operationId: GetPricingRuleTypes - summary: List Pricing - description: Retrieve a list of pricing. The pricing can be filtered by fields such as `id`. The pricing can also be sorted or paginated. + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The product category's q. + required: false + schema: + type: string + title: q + description: The product category's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product category's ID. + - type: array + description: The product category's ID. + items: + type: string + title: id + description: The id's ID. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The product category's description. + - type: array + description: The product category's description. + items: + type: string + title: description + description: The description's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product category's handle. + - type: array + description: The product category's handle. + items: + type: string + title: handle + description: The handle's details. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: The product category's parent category id. + - type: array + description: The product category's parent category id. + items: + type: string + title: parent_category_id + description: The parent category id's details. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + - name: is_internal + in: query + description: The product category's is internal. + required: true + schema: + type: boolean + title: is_internal + description: The product category's is internal. + - name: is_active + in: query + description: The product category's is active. + required: true + schema: + type: boolean + title: is_active + description: The product category's is active. + - name: created_at + in: query + description: The product category's created at. + required: false + schema: + type: object + description: The product category's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product category's updated at. + required: false + schema: + type: object + description: The product category's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product category's deleted at. + required: false + schema: + type: object + description: The product category's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetPricingRuleTypesParams' x-codeSamples: - lang: Shell label: cURL source: |- - curl '{backend_url}/admin/pricing/rule-types' \ + curl '{backend_url}/admin/product-categories' \ -H 'x-medusa-access-token: {api_token}' tags: - - Pricing + - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryListResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2768,11 +9809,57 @@ paths: '500': $ref: '#/components/responses/500_error' post: - operationId: PostPricingRuleTypes - summary: Create Pricing - description: Create a pricing. + operationId: PostProductCategories + summary: Create Product Category + description: Create a product category. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2781,22 +9868,65 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPricingRuleTypesReq' + 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. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/pricing/rule-types' \ + curl -X POST '{backend_url}/admin/product-categories' \ -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Thurman", - "rule_attribute": "{value}", - "default_priority": 4640267816665088 + "name": "Vesta", + "parent_category_id": "{value}", + "metadata": {} }' tags: - - Pricing + - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2809,37 +9939,100 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/pricing/rule-types/{id}: + /admin/product-categories/{id}: get: - operationId: GetPricingRuleTypesId - summary: List Rule Types - description: Retrieve a list of rule types in a pricing. The rule types can be filtered by fields like FILTER FIELDS. The rule types can also be paginated. + operationId: GetProductCategoriesId + summary: Get a Product Category + description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. x-authenticated: true parameters: - name: id in: path - description: The pricing's ID. + description: The product category's ID. required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams' x-codeSamples: - lang: Shell label: cURL source: |- - curl '{backend_url}/admin/pricing/rule-types/{id}' \ + curl '{backend_url}/admin/product-categories/{id}' \ -H 'x-medusa-access-token: {api_token}' tags: - - Pricing + - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2853,17 +10046,63 @@ paths: '500': $ref: '#/components/responses/500_error' post: - operationId: PostPricingRuleTypesId - summary: Add Rule Types to Pricing - description: Add a list of rule types to a pricing. + operationId: PostProductCategoriesId + summary: Update a Product Category + description: Update a product category's details. x-authenticated: true parameters: - name: id in: path - description: The pricing's ID. + description: The product category's ID. required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2872,16 +10111,63 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPricingRuleTypesRuleTypeReq' + type: object + description: SUMMARY + required: + - 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. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/pricing/rule-types/{id}' \ - -H 'x-medusa-access-token: {api_token}' + curl -X POST '{backend_url}/admin/product-categories/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "parent_category_id": "{value}", + "metadata": {} + }' tags: - - Pricing + - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -2895,17 +10181,149 @@ paths: '500': $ref: '#/components/responses/500_error' delete: - operationId: DeletePricingRuleTypesId - summary: Remove Rule Types from Pricing - description: Remove a list of rule types from a pricing. This doesn't delete the Rule Type, only the association between the Rule Type and the pricing. + operationId: DeleteProductCategoriesId + summary: Delete a Product Category + description: Delete a product category. x-authenticated: true parameters: - name: id in: path - description: The pricing's ID. + description: The product category's ID. required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/product-categories/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Categories + 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' + /admin/product-categories/{id}/products: + post: + operationId: PostProductCategoriesIdProducts + summary: Add Products to Product Category + description: Add a list of products to a product category. + x-authenticated: true + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2914,16 +10332,1238 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq' + type: object + description: SUMMARY + properties: + add: + type: array + description: The product category's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The product category's remove. + items: + type: string + title: remove + description: The remove's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \ + curl -X POST '{backend_url}/admin/product-categories/{id}/products' \ -H 'x-medusa-access-token: {api_token}' tags: - - Pricing + - Product Categories responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductCategoryResponse' + '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' + /admin/product-tags: + get: + operationId: GetProductTags + summary: List Product Tags + description: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The product tag's q. + required: false + schema: + type: string + title: q + description: The product tag's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product tag's ID. + - type: array + description: The product tag's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The product tag's value. + - type: array + description: The product tag's value. + items: + type: string + title: value + description: The value's details. + - name: created_at + in: query + description: The product tag's created at. + required: false + schema: + type: object + description: The product tag's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product tag's updated at. + required: false + schema: + type: object + description: The product tag's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product tag's deleted at. + required: false + schema: + type: object + description: The product tag's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/product-tags' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Tags + 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' + post: + operationId: PostProductTags + summary: Create Product Tag + description: Create a product tag. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/product-tags' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "value": "{value}", + "metadata": {} + }' + tags: + - Product Tags + 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' + /admin/product-tags/{id}: + get: + operationId: GetProductTagsId + summary: Get a Product Tag + description: Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/product-tags/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Tags + 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' + post: + operationId: PostProductTagsId + summary: Update a Product Tag + description: Update a product tag's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/product-tags/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' + tags: + - Product Tags + 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' + delete: + operationId: DeleteProductTagsId + summary: Delete a Product Tag + description: Delete a product tag. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/product-tags/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Tags + 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' + /admin/product-types: + get: + operationId: GetProductTypes + summary: List Product Types + description: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The product type's q. + required: false + schema: + type: string + title: q + description: The product type's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product type's ID. + - type: array + description: The product type's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The product type's value. + - type: array + description: The product type's value. + items: + type: string + title: value + description: The value's details. + - name: created_at + in: query + description: The product type's created at. + required: false + schema: + type: object + description: The product type's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product type's updated at. + required: false + schema: + type: object + description: The product type's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product type's deleted at. + required: false + schema: + type: object + description: The product type's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/product-types' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Types + 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' + post: + operationId: PostProductTypes + summary: Create Product Type + description: Create a product type. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/product-types' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "value": "{value}", + "metadata": {} + }' + tags: + - Product Types + 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' + /admin/product-types/{id}: + get: + operationId: GetProductTypesId + summary: Get a Product Type + description: Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/product-types/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Types + 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' + post: + operationId: PostProductTypesId + summary: Update a Product Type + description: Update a product type's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + value: + type: string + title: value + description: The product type's value. + metadata: + type: object + description: The product type's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/product-types/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' + tags: + - Product Types + 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' + delete: + operationId: DeleteProductTypesId + summary: Delete a Product Type + description: Delete a product type. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/product-types/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Product Types + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -2942,16 +11582,13973 @@ paths: summary: List Products description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: price_list_id + in: query + required: false + schema: + oneOf: + - type: string + title: price_list_id + description: The product's price list id. + - type: array + description: The product's price list id. + items: + type: string + title: price_list_id + description: The price list id's details. + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: array + description: The product's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The product's sales channel id. + - type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product's handle. + - type: array + description: The product's handle. + items: + type: string + title: handle + description: The handle's details. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: false + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: object + description: The product's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + - name: type_id + in: query + required: false + schema: + oneOf: + - type: string + title: type_id + description: The product's type id. + - type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: The product's category id. + - type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The product's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The category id's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + - name: categories + in: query + required: false + schema: + oneOf: + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The id's $eq. + - type: object + description: The id's $eq. + x-schemaName: RegExp + - type: array + description: The id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The id's $ne. + - type: object + description: The id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The id's $not. + - type: object + description: The id's $not. + x-schemaName: RegExp + - type: object + description: The id's $not. + - type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The id's $gt. + - type: object + description: The id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The id's $gte. + - type: object + description: The id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The id's $lt. + - type: object + description: The id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The id's $lte. + - type: object + description: The id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + $or: + type: array + description: The id's $or. + items: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + $eq: + oneOf: + - type: array + description: The id's $eq. + items: + type: string + title: $eq + description: The $eq's details. + - type: array + description: The id's $eq. + items: + type: array + description: The $eq's details. + items: + type: string + title: $eq + description: The $eq's details. + $ne: + type: array + description: The id's $ne. + items: + type: string + title: $ne + description: The $ne's details. + $in: + type: array + description: The id's $in. + items: + type: array + description: The $in's details. + items: + type: string + title: $in + description: The $in's details. + $nin: + type: array + description: The id's $nin. + items: + type: array + description: The $nin's details. + items: + type: string + title: $nin + description: The $nin's details. + $not: + type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + $gt: + type: array + description: The id's $gt. + items: + type: string + title: $gt + description: The $gt's details. + $gte: + type: array + description: The id's $gte. + items: + type: string + title: $gte + description: The $gte's details. + $lt: + type: array + description: The id's $lt. + items: + type: string + title: $lt + description: The $lt's details. + $lte: + type: array + description: The id's $lte. + items: + type: string + title: $lte + description: The $lte's details. + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - name: collection_id + in: query + required: false + schema: + oneOf: + - type: string + title: collection_id + description: The product's collection id. + - type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The product's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The collection id's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The created at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The updated at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The deleted at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + - name: $and + in: query + description: The product's $and. + required: false + schema: + type: array + description: The product's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + - type: object + description: The category id's $not. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + categories: + oneOf: + - type: object + description: The $and's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + - type: object + description: The $and's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + - type: object + description: The collection id's $not. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + created_at: + type: object + description: The $and's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + - type: object + description: The created at's $not. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + updated_at: + type: object + description: The $and's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + - type: object + description: The updated at's $not. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + deleted_at: + type: object + description: The $and's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + - type: object + description: The deleted at's $not. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - name: $or + in: query + description: The product's $or. + required: false + schema: + type: array + description: The product's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + - type: object + description: The category id's $not. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + categories: + oneOf: + - type: object + description: The $or's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + - type: object + description: The $or's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + - type: object + description: The collection id's $not. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + created_at: + type: object + description: The $or's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + - type: object + description: The created at's $not. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + updated_at: + type: object + description: The $or's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + - type: object + description: The updated at's $not. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + deleted_at: + type: object + description: The $or's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + - type: object + description: The deleted at's $not. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetProductsParams' x-codeSamples: - lang: Shell label: cURL @@ -2961,6 +25558,41 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - products + properties: + products: + type: array + description: The product's products. + items: + type: object '400': $ref: '#/components/responses/400_error' '401': @@ -2978,20 +25610,81 @@ paths: summary: Create Product description: Create a product. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateProduct' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/products' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}" + }' tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3004,10 +25697,95 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/products/batch: + post: + operationId: PostProductsBatch + summary: Create Product + description: Create a product. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/AdminBatchProductRequest' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/batch' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchProductResponse' + '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' /admin/products/{id}: get: operationId: GetProductsId @@ -3021,6 +25799,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3034,6 +25858,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3046,10 +25876,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsId summary: Update a Product @@ -3062,10 +25888,61 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateProduct' x-codeSamples: - lang: Shell label: cURL @@ -3075,6 +25952,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3087,10 +25970,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsId summary: Delete a Product @@ -3103,6 +25982,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3116,6 +26041,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3128,10 +26059,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/products/{id}/options: get: operationId: GetProductsIdOptions @@ -3145,6 +26072,1080 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. + - name: product_id + in: query + required: false + schema: + oneOf: + - type: string + title: product_id + description: The product's product id. + - type: array + description: The product's product id. + items: + type: string + title: product_id + description: The product id's details. + - name: $and + in: query + description: The product's $and. + required: false + schema: + type: array + description: The product's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - name: $or + in: query + description: The product's $or. + required: false + schema: + type: array + description: The product's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. security: - api_token: [] - cookie_auth: [] @@ -3158,6 +27159,41 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - product_options + properties: + product_options: + type: array + description: The product's product options. + items: + $ref: '#/components/schemas/AdminProductOption' '400': $ref: '#/components/responses/400_error' '401': @@ -3170,10 +27206,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdOptions summary: Add Options to Product @@ -3186,19 +27218,83 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateProductOption' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/options' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}", + "values": [ + "{value}" + ] + }' tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3211,10 +27307,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/products/{id}/options/{option_id}: get: operationId: GetProductsIdOptionsOption_id @@ -3234,6 +27326,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3247,6 +27385,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductOptionResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3259,10 +27403,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdOptionsOption_id summary: Add Options to Product @@ -3281,10 +27421,61 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateProductOption' x-codeSamples: - lang: Shell label: cURL @@ -3294,6 +27485,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3306,10 +27503,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsIdOptionsOption_id summary: Remove Options from Product @@ -3328,6 +27521,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3341,6 +27580,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductOptionDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3353,10 +27598,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/products/{id}/variants: get: operationId: GetProductsIdVariants @@ -3370,6 +27611,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3383,6 +27670,41 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - variants + properties: + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/AdminProductVariant' '400': $ref: '#/components/responses/400_error' '401': @@ -3395,10 +27717,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdVariants summary: Add Variants to Product @@ -3411,19 +27729,81 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateProductVariant' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/products/{id}/variants' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "title": "{value}", + "prices": [] + }' tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3436,10 +27816,258 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/products/{id}/variants/batch: + post: + operationId: PostProductsIdVariantsBatch + summary: Add Variants to Product + description: Add a list of variants to a product. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/AdminBatchProductVariantRequest' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/{id}/variants/batch' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminBatchProductVariantResponse' + '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' + /admin/products/{id}/variants/inventory-items/batch: + post: + operationId: PostProductsIdVariantsInventoryItemsBatch + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The product's create. + items: + type: object + description: The create's details. + required: + - required_quantity + - inventory_item_id + - variant_id + properties: + required_quantity: + type: number + title: required_quantity + description: The create's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The create's inventory item id. + variant_id: + type: string + title: variant_id + description: The create's variant id. + update: + type: array + description: The product's update. + items: + type: object + description: The update's details. + required: + - required_quantity + - inventory_item_id + - variant_id + properties: + required_quantity: + type: number + title: required_quantity + description: The update's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The update's inventory item id. + variant_id: + type: string + title: variant_id + description: The update's variant id. + delete: + type: array + description: The product's delete. + items: + type: object + description: The delete's details. + required: + - inventory_item_id + - variant_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The delete's inventory item id. + variant_id: + type: string + title: variant_id + description: The delete's variant id. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + 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' /admin/products/{id}/variants/{variant_id}: get: operationId: GetProductsIdVariantsVariant_id @@ -3459,6 +28087,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3472,6 +28146,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3484,10 +28164,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdVariantsVariant_id summary: Add Variants to Product @@ -3506,10 +28182,61 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateProductVariant' x-codeSamples: - lang: Shell label: cURL @@ -3519,6 +28246,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3531,10 +28264,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsIdVariantsVariant_id summary: Remove Variants from Product @@ -3553,6 +28282,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3566,6 +28341,12 @@ paths: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminProductVariantDeleteResponse' '400': $ref: '#/components/responses/400_error' '401': @@ -3578,17 +28359,527 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/products/{id}/variants/{variant_id}/inventory-items: + post: + operationId: PostProductsIdVariantsVariant_idInventoryItems + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + 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's variant id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/AdminCreateVariantInventoryItem' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "required_quantity": 7390879820021760, + "inventory_item_id": "{value}" + }' + tags: + - Products + 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' + /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: + post: + operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + 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's variant id. + required: true + schema: + type: string + - name: inventory_item_id + in: path + description: The product's inventory item id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateVariantInventoryItem' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "required_quantity": 5324804697620480 + }' + tags: + - Products + 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' + delete: + operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id + summary: Remove Inventory Items from Product + description: Remove a list of inventory items from a product. This doesn't delete the Inventory Item, only the association between the Inventory Item and the product. + 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's variant id. + required: true + schema: + type: string + - name: inventory_item_id + in: path + description: The product's inventory item id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Products + 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' /admin/promotions: get: operationId: GetPromotions summary: List Promotions description: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The promotion's q. + required: false + schema: + type: string + title: q + description: The promotion's q. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The promotion's code. + - type: array + description: The promotion's code. + items: + type: string + title: code + description: The code's details. + - name: campaign_id + in: query + required: false + schema: + oneOf: + - type: string + title: campaign_id + description: The promotion's campaign id. + - type: array + description: The promotion's campaign id. + items: + type: string + title: campaign_id + description: The campaign id's details. + - name: application_method + in: query + description: The promotion's application method. + required: false + schema: + type: object + description: The promotion's application method. + properties: + currency_code: + oneOf: + - type: string + title: currency_code + description: The application method's currency code. + - type: array + description: The application method's currency code. + items: + type: string + title: currency_code + description: The currency code's details. + - name: created_at + in: query + description: The promotion's created at. + required: false + schema: + type: object + description: The promotion's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The promotion's updated at. + required: false + schema: + type: object + description: The promotion's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The promotion's deleted at. + required: false + schema: + type: object + description: The promotion's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -3602,6 +28893,8 @@ paths: tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3614,16 +28907,449 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostPromotions summary: Create Promotion description: Create a promotion. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - code + - type + - campaign_id + - application_method + properties: + code: + type: string + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + type: + type: string + enum: + - standard + - buyget + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - value + - currency_code + - max_quantity + - type + - target_type + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/promotions' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "code": "{value}", + "type": "{value}", + "campaign_id": "{value}", + "application_method": { + "description": "{value}", + "value": 1841223411171328, + "currency_code": "{value}", + "max_quantity": 2960098049654784, + "type": "{value}", + "target_type": "{value}", + "allocation": "{value}", + "target_rules": [], + "buy_rules": [], + "apply_to_quantity": 708643867590656, + "buy_rules_min_quantity": 3167972149428224 + } + }' + tags: + - Promotions + 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' + /admin/promotions/rule-attribute-options/{rule_type}: + get: + operationId: GetPromotionsRuleAttributeOptionsRule_type + summary: List Rule Attribute Options + description: Retrieve a list of rule attribute options in a promotion. The rule attribute options can be filtered by fields like FILTER FIELDS. The rule attribute options can also be paginated. + x-authenticated: true + parameters: + - name: rule_type + in: path + description: The promotion's rule type. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: promotion_type + in: query + description: The promotion's promotion type. + required: false + schema: + type: string + title: promotion_type + description: The promotion's promotion type. + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + title: application_method_type + description: The promotion's application method type. security: - api_token: [] - cookie_auth: [] @@ -3632,11 +29358,121 @@ paths: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/promotions' \ + curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \ -H 'x-medusa-access-token: {api_token}' tags: - Promotions 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' + /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}: + get: + operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id + summary: 'List ' + description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. + x-authenticated: true + parameters: + - name: rule_type + in: path + description: The promotion's rule type. + required: true + schema: + type: string + - name: rule_attribute_id + in: path + description: The promotion's rule attribute id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: promotion_type + in: query + description: The promotion's promotion type. + required: false + schema: + type: string + title: promotion_type + description: The promotion's promotion type. + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + title: application_method_type + description: The promotion's application method type. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Promotions + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3649,10 +29485,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/promotions/{id}: get: operationId: GetPromotionsId @@ -3666,15 +29498,56 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminGetPromotionsParams' x-codeSamples: - lang: Shell label: cURL @@ -3684,6 +29557,8 @@ paths: tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3708,6 +29583,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3716,16 +29637,281 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionReq' + type: object + description: SUMMARY + required: + - campaign_id + properties: + code: + type: string + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + type: + type: string + enum: + - standard + - buyget + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - max_quantity + - currency_code + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/promotions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "campaign_id": "{value}" + }' tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3750,6 +29936,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3763,6 +29995,8 @@ paths: tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3775,15 +30009,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/promotions/{id}/buy-rules/batch/add: + /admin/promotions/{id}/buy-rules/batch: post: - operationId: PostPromotionsIdBuyRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. + operationId: PostPromotionsIdBuyRulesBatch + summary: Add Buy Rules to Promotion + description: Add a list of buy rules to a promotion. x-authenticated: true parameters: - name: id @@ -3792,6 +30022,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3800,27 +30076,112 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq' + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/add' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] - }' + curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ + -H 'x-medusa-access-token: {api_token}' tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3833,11 +30194,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/promotions/{id}/buy-rules/batch/remove: + /admin/promotions/{id}/rules/batch: post: - operationId: PostPromotionsIdBuyRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. + operationId: PostPromotionsIdRulesBatch + summary: Add Rules to Promotion + description: Add a list of rules to a promotion. x-authenticated: true parameters: - name: id @@ -3846,6 +30207,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3854,22 +30261,112 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq' + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rule_ids": [ - "{value}" - ] - }' + curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ + -H 'x-medusa-access-token: {api_token}' tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3882,11 +30379,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/promotions/{id}/rules/batch/add: + /admin/promotions/{id}/target-rules/batch: post: - operationId: PostPromotionsIdRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. + operationId: PostPromotionsIdTargetRulesBatch + summary: Add Target Rules to Promotion + description: Add a list of target rules to a promotion. x-authenticated: true parameters: - name: id @@ -3895,6 +30392,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3903,27 +30446,112 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq' + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/add' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] - }' + curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ + -H 'x-medusa-access-token: {api_token}' tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -3936,11 +30564,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - /admin/promotions/{id}/rules/batch/remove: - post: - operationId: PostPromotionsIdRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. + /admin/promotions/{id}/{rule_type}: + get: + operationId: GetPromotionsIdRule_type + summary: 'List ' + description: Retrieve a list of in a promotion. The can be filtered by fields like FILTER FIELDS. The can also be paginated. x-authenticated: true parameters: - name: id @@ -3949,188 +30577,73 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rule_ids": [ - "{value}" - ] - }' - tags: - - Promotions - responses: - '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' - /admin/promotions/{id}/rules/batch/update: - post: - operationId: PostPromotionsIdRulesBatchUpdate - summary: Add Updates to Promotion - description: Add a list of updates to a promotion. - x-authenticated: true - parameters: - - name: id + - name: rule_type in: path - description: The promotion's ID. + description: The promotion's rule type. required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch/update' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rules": [ - { - "id": "id_orjnxCxIQlJAp4", - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] - }' - tags: - - Promotions - responses: - '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' - /admin/promotions/{id}/target-rules/batch/add: - post: - operationId: PostPromotionsIdTargetRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq' - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/add' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rules": [ - { - "attribute": "{value}", - "values": [ - "{value}" - ] - } - ] - }' - tags: - - Promotions - responses: - '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' - /admin/promotions/{id}/target-rules/batch/remove: - post: - operationId: PostPromotionsIdTargetRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false schema: type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq' x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch/remove' \ - -H 'x-medusa-access-token: {api_token}' \ - -H 'Content-Type: application/json' \ - --data-raw '{ - "rule_ids": [ - "{value}" - ] - }' + curl '{backend_url}/admin/promotions/{id}/{rule_type}' \ + -H 'x-medusa-access-token: {api_token}' tags: - Promotions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4149,7 +30662,210 @@ paths: summary: List Regions description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The region's q. + required: false + schema: + type: string + title: q + description: The region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The region's ID. + - type: array + description: The region's ID. + items: + type: string + title: id + description: The id's ID. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The region's code. + - type: array + description: The region's code. + items: + type: string + title: code + description: The code's details. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The region's name. + - type: array + description: The region's name. + items: + type: string + title: name + description: The name's details. + - name: created_at + in: query + description: The region's created at. + required: false + schema: + type: object + description: The region's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The region's updated at. + required: false + schema: + type: object + description: The region's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The region's deleted at. + required: false + schema: + type: object + description: The region's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -4163,6 +30879,8 @@ paths: tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4175,29 +30893,119 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostRegions summary: Create Region description: Create a region. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/regions' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Heloise", + "currency_code": "{value}", + "metadata": {} + }' tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4210,10 +31018,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/regions/{id}: get: operationId: GetRegionsId @@ -4227,6 +31031,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4240,6 +31090,8 @@ paths: tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4252,10 +31104,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostRegionsId summary: Update a Region @@ -4268,19 +31116,109 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - 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. x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/regions/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4293,10 +31231,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteRegionsId summary: Delete a Region @@ -4309,6 +31243,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4322,6 +31302,8 @@ paths: tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4334,17 +31316,1849 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/reservations: + get: + operationId: GetReservations + summary: List Reservations + description: Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The reservation's location id. + - type: array + description: The reservation's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: inventory_item_id + in: query + required: false + schema: + oneOf: + - type: string + title: inventory_item_id + description: The reservation's inventory item id. + - type: array + description: The reservation's inventory item id. + items: + type: string + title: inventory_item_id + description: The inventory item id's details. + - name: line_item_id + in: query + required: false + schema: + oneOf: + - type: string + title: line_item_id + description: The reservation's line item id. + - type: array + description: The reservation's line item id. + items: + type: string + title: line_item_id + description: The line item id's details. + - name: created_by + in: query + required: false + schema: + oneOf: + - type: string + title: created_by + description: The reservation's created by. + - type: array + description: The reservation's created by. + items: + type: string + title: created_by + description: The created by's details. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The reservation's description. + - type: object + description: The reservation's description. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: quantity + in: query + description: The reservation's quantity. + required: false + schema: + type: object + description: The reservation's quantity. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: created_at + in: query + description: The reservation's created at. + required: false + schema: + type: object + description: The reservation's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The reservation's updated at. + required: false + schema: + type: object + description: The reservation's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The reservation's deleted at. + required: false + schema: + type: object + description: The reservation's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/reservations' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Reservations + 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' + post: + operationId: PostReservations + summary: Create Reservation + description: Create a reservation. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/reservations' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "line_item_id": "{value}", + "location_id": "{value}", + "inventory_item_id": "{value}", + "quantity": 3268935814217728, + "description": "{value}", + "metadata": {} + }' + tags: + - Reservations + 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' + /admin/reservations/{id}: + get: + operationId: GetReservationsId + summary: Get a Reservation + description: Retrieve a reservation by its ID. You can expand the reservation's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/reservations/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Reservations + 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' + post: + operationId: PostReservationsId + summary: Update a Reservation + description: Update a reservation's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - description + - metadata + properties: + location_id: + type: string + title: location_id + description: The reservation's location 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/reservations/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "description": "{value}", + "metadata": {} + }' + tags: + - Reservations + 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' + delete: + operationId: DeleteReservationsId + summary: Delete a Reservation + description: Delete a reservation. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/reservations/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Reservations + 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' + /admin/return-reasons: + get: + operationId: GetReturnReasons + summary: List Return Reasons + description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/return-reasons' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Return Reasons + 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' + post: + operationId: PostReturnReasons + summary: Create Return Reason + description: Create a return reason. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateOrderReturnReason' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/return-reasons' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "value": "{value}", + "label": "{value}" + }' + tags: + - Return Reasons + 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' + /admin/return-reasons/{id}: + get: + operationId: GetReturnReasonsId + summary: Get a Return Reason + description: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/return-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Return Reasons + 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' + post: + operationId: PostReturnReasonsId + summary: Update a Return Reason + description: Update a return reason's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateOrderReturnReason' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/return-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Return Reasons + 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' + delete: + operationId: DeleteReturnReasonsId + summary: Delete a Return Reason + description: Delete a return reason. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Return Reasons + 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' + /admin/returns: + get: + operationId: GetReturns + summary: List Returns + description: Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/returns' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostReturns + summary: Create Return + description: Create a return. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReturnsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}", + "items": [ + { + "id": "id_7DO5H2LbSN3p7IzB", + "quantity": 1357590174892032, + "reason_id": "{value}", + "note": "{value}" + } + ], + "return_shipping": { + "option_id": "{value}", + "price": 5112171463704576 + }, + "internal_note": "{value}", + "location_id": "{value}" + }' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/returns/{id}: + get: + operationId: GetReturnsId + summary: Get a Return + description: Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/returns/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/returns/{id}/cancel: + post: + operationId: PostReturnsIdCancel + summary: Add Cancels to Return + description: Add a list of cancels to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/cancel' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/returns/{id}/receive: + post: + operationId: PostReturnsIdReceive + summary: Add Receives to Return + description: Add a list of receives to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminPostReceiveReturnsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/returns/{id}/receive' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "return_id": "{value}", + "items": [ + { + "id": "id_qfy3t6cU7m8O5cJ5zs", + "quantity": 6429460591017984, + "reason_id": "{value}", + "note": "{value}" + } + ], + "internal_note": "{value}" + }' + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/sales-channels: get: operationId: GetSalesChannels summary: List Sales Channels description: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The sales channel's q. + required: false + schema: + type: string + title: q + description: The sales channel's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The sales channel's ID. + - type: array + description: The sales channel's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The sales channel's name. + - type: array + description: The sales channel's name. + items: + type: string + title: name + description: The name's details. + - name: description + in: query + description: The sales channel's description. + required: false + schema: + type: string + title: description + description: The sales channel's description. + - name: is_disabled + in: query + description: The sales channel's is disabled. + required: true + schema: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + - name: created_at + in: query + description: The sales channel's created at. + required: false + schema: + type: object + description: The sales channel's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The sales channel's updated at. + required: false + schema: + type: object + description: The sales channel's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The sales channel's deleted at. + required: false + schema: + type: object + description: The sales channel's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The sales channel's location id. + - type: array + description: The sales channel's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: publishable_key_id + in: query + required: false + schema: + oneOf: + - type: string + title: publishable_key_id + description: The sales channel's publishable key id. + - type: array + description: The sales channel's publishable key id. + items: + type: string + title: publishable_key_id + description: The publishable key id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -4358,6 +33172,8 @@ paths: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4370,29 +33186,84 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostSalesChannels summary: Create Sales Channel description: Create a sales channel. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateSalesChannel' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/sales-channels' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Linnea", + "description": "{value}", + "metadata": {} + }' tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4405,10 +33276,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/sales-channels/{id}: get: operationId: GetSalesChannelsId @@ -4422,6 +33289,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4435,6 +33348,8 @@ paths: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4447,10 +33362,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostSalesChannelsId summary: Update a Sales Channel @@ -4463,19 +33374,77 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateSalesChannel' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/sales-channels/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "description": "{value}", + "metadata": {} + }' tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4488,10 +33457,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -4504,6 +33469,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4517,6 +33528,8 @@ paths: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4529,15 +33542,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/sales-channels/{id}/products/batch/add: + /admin/sales-channels/{id}/products: post: - operationId: PostSalesChannelsIdProductsBatchAdd - summary: Add Adds to Sales Channel - description: Add a list of adds to a sales channel. + operationId: PostSalesChannelsIdProducts + summary: Add Products to Sales Channel + description: Add a list of products to a sales channel. x-authenticated: true parameters: - name: id @@ -4546,19 +33555,88 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The sales channel's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The sales channel's remove. + items: + type: string + title: remove + description: The remove's details. x-codeSamples: - lang: Shell label: cURL source: |- - curl -X POST '{backend_url}/admin/sales-channels/{id}/products/batch/add' \ + curl -X POST '{backend_url}/admin/sales-channels/{id}/products' \ -H 'x-medusa-access-token: {api_token}' tags: - Sales Channels responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4571,17 +33649,348 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/stock-locations: - post: - operationId: PostStockLocations - summary: Create Stock Location - description: Create a stock location. + /admin/shipping-options: + get: + operationId: GetShippingOptions + summary: List Shipping Options + description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The shipping option's ID. + - type: array + description: The shipping option's ID. + items: + type: string + title: id + description: The id's ID. + - name: q + in: query + description: The shipping option's q. + required: false + schema: + type: string + title: q + description: The shipping option's q. + - name: service_zone_id + in: query + required: false + schema: + oneOf: + - type: string + title: service_zone_id + description: The shipping option's service zone id. + - type: array + description: The shipping option's service zone id. + items: + type: string + title: service_zone_id + description: The service zone id's details. + - name: shipping_profile_id + in: query + required: false + schema: + oneOf: + - type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + - type: array + description: The shipping option's shipping profile id. + items: + type: string + title: shipping_profile_id + description: The shipping profile id's details. + - name: provider_id + in: query + required: false + schema: + oneOf: + - type: string + title: provider_id + description: The shipping option's provider id. + - type: array + description: The shipping option's provider id. + items: + type: string + title: provider_id + description: The provider id's details. + - name: shipping_option_type_id + in: query + required: false + schema: + oneOf: + - type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + - type: array + description: The shipping option's shipping option type id. + items: + type: string + title: shipping_option_type_id + description: The shipping option type id's details. + - name: created_at + in: query + description: The shipping option's created at. + required: false + schema: + type: object + description: The shipping option's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The shipping option's updated at. + required: false + schema: + type: object + description: The shipping option's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The shipping option's deleted at. + required: false + schema: + type: object + description: The shipping option's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/shipping-options' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The shipping option's limit. + offset: + type: number + title: offset + description: The shipping option's offset. + count: + type: number + title: count + description: The shipping option's count. + - type: object + description: SUMMARY + required: + - shipping_options + properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + type: object + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostShippingOptions + summary: Create Shipping Option + description: Create a shipping option. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4590,7 +33999,1661 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostStockLocationsReq' + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/shipping-options' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Julie", + "service_zone_id": "{value}", + "shipping_profile_id": "{value}", + "price_type": "{value}", + "provider_id": "{value}", + "type": { + "label": "{value}", + "description": "{value}", + "code": "{value}" + }, + "prices": [] + }' + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingOptionResponse' + '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' + /admin/shipping-options/{id}: + post: + operationId: PostShippingOptionsId + summary: Update a Shipping Option + description: Update a shipping option's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + name: + type: string + title: name + description: The shipping option's name. + 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. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile 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. + properties: + id: + type: string + title: id + description: The price's ID. + 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. + properties: + id: + type: string + title: id + description: The price's ID. + 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: + oneOf: + - 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. + - type: object + description: The rule's rules. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The rule's ID. + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/shipping-options/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingOptionResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteShippingOptionsId + summary: Delete a Shipping Option + description: Delete a shipping option. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingOptionDeleteResponse' + '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' + /admin/shipping-options/{id}/rules/batch: + post: + operationId: PostShippingOptionsIdRulesBatch + summary: Add Rules to Shipping Option + description: Add a list of rules to a shipping option. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The shipping option's create. + items: + type: object + description: The create's details. + required: + - operator + - attribute + - value + properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The create's attribute. + value: + oneOf: + - type: string + title: value + description: The create's value. + - type: array + description: The create's value. + items: + type: string + title: value + description: The value's details. + update: + type: array + description: The shipping option's update. + items: + type: object + description: The update's details. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The update's attribute. + value: + oneOf: + - type: string + title: value + description: The update's value. + - type: array + description: The update's value. + items: + type: string + title: value + description: The value's details. + delete: + type: array + description: The shipping option's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Options + 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' + /admin/shipping-profiles: + get: + operationId: GetShippingProfiles + summary: List Shipping Profiles + description: Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The shipping profile's ID. + - type: array + description: The shipping profile's ID. + items: + type: string + title: id + description: The id's ID. + - name: q + in: query + description: The shipping profile's q. + required: false + schema: + type: string + title: q + description: The shipping profile's q. + - name: type + in: query + description: The shipping profile's type. + required: false + schema: + type: string + title: type + description: The shipping profile's type. + - name: name + in: query + description: The shipping profile's name. + required: false + schema: + type: string + title: name + description: The shipping profile's name. + - name: created_at + in: query + description: The shipping profile's created at. + required: false + schema: + type: object + description: The shipping profile's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The shipping profile's updated at. + required: false + schema: + type: object + description: The shipping profile's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The shipping profile's deleted at. + required: false + schema: + type: object + description: The shipping profile's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/shipping-profiles' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The shipping profile's limit. + offset: + type: number + title: offset + description: The shipping profile's offset. + count: + type: number + title: count + description: The shipping profile's count. + - type: object + description: SUMMARY + required: + - shipping_profiles + properties: + shipping_profiles: + type: array + description: The shipping profile's shipping profiles. + items: + $ref: '#/components/schemas/AdminShippingProfile' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostShippingProfiles + summary: Create Shipping Profile + description: Create a shipping profile. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - type + - metadata + properties: + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/shipping-profiles' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Percy", + "type": "{value}", + "metadata": {} + }' + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingProfileResponse' + '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' + /admin/shipping-profiles/{id}: + get: + operationId: GetShippingProfilesId + summary: Get a Shipping Profile + description: Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/shipping-profiles/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingProfileResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostShippingProfilesId + summary: Update a Shipping Profile + description: Update a shipping profile's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/shipping-profiles/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingProfileResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + delete: + operationId: DeleteShippingProfilesId + summary: Delete a Shipping Profile + description: Delete a shipping profile. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingProfileDeleteResponse' + '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' + /admin/stock-locations: + get: + operationId: GetStockLocations + summary: List Stock Locations + description: Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The stock location's q. + required: false + schema: + type: string + title: q + description: The stock location's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The stock location's ID. + - type: array + description: The stock location's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The stock location's name. + - type: array + description: The stock location's name. + items: + type: string + title: name + description: The name's details. + - name: address_id + in: query + required: false + schema: + oneOf: + - type: string + title: address_id + description: The stock location's address id. + - type: array + description: The stock location's address id. + items: + type: string + title: address_id + description: The address id's details. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The stock location's sales channel id. + - type: array + description: The stock location's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: created_at + in: query + description: The stock location's created at. + required: false + schema: + type: object + description: The stock location's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The stock location's updated at. + required: false + schema: + type: object + description: The stock location's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The stock location's deleted at. + required: false + schema: + type: object + description: The stock location's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/stock-locations' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + post: + operationId: PostStockLocations + summary: Create Stock Location + description: Create a stock location. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminCreateStockLocation' x-codeSamples: - lang: Shell label: cURL @@ -4599,7 +35662,9 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Dorthy" + "name": "Maryam", + "address_id": "{value}", + "metadata": {} }' tags: - Stock Locations @@ -4631,6 +35696,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4658,6 +35769,101 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + post: + operationId: PostStockLocationsId + summary: Update a Stock Location + description: Update a stock location's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateStockLocation' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/stock-locations/{id}' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "address_id": "{value}", + "metadata": {} + }' + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -4670,6 +35876,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4697,13 +35949,319 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /admin/stock-locations/{id}/fulfillment-sets: + post: + operationId: PostStockLocationsIdFulfillmentSets + summary: Add Fulfillment Sets to Stock Location + description: Add a list of fulfillment sets to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - type + properties: + name: + type: string + title: name + description: The stock location's name. + type: + type: string + title: type + description: The stock location's type. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/stock-locations/{id}/fulfillment-sets' \ + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Helene", + "type": "{value}" + }' + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /admin/stock-locations/{id}/sales-channels: + post: + operationId: PostStockLocationsIdSalesChannels + summary: Add Sales Channels to Stock Location + description: Add a list of sales channels to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The stock location's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The stock location's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/stock-locations/{id}/sales-channels' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/stores: get: operationId: GetStores summary: List Stores description: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The store's q. + required: false + schema: + type: string + title: q + description: The store's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The store's ID. + - type: array + description: The store's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The store's name. + - type: array + description: The store's name. + items: + type: string + title: name + description: The name's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -4717,6 +36275,8 @@ paths: tags: - Stores responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4729,10 +36289,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/stores/{id}: get: operationId: GetStoresId @@ -4746,6 +36302,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4759,6 +36361,8 @@ paths: tags: - Stores responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4771,10 +36375,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostStoresId summary: Update a Store @@ -4787,19 +36387,80 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateStore' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/stores/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "name": "Melvina", + "default_sales_channel_id": "{value}", + "default_region_id": "{value}", + "default_location_id": "{value}", + "metadata": {} + }' tags: - Stores responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4812,17 +36473,224 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/tax-rates: get: operationId: GetTaxRates summary: List Tax Rates description: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The tax rate's q. + required: false + schema: + type: string + title: q + description: The tax rate's q. + - name: tax_region_id + in: query + required: false + schema: + oneOf: + - type: string + title: tax_region_id + description: The tax rate's tax region id. + - type: array + description: The tax rate's tax region id. + items: + type: string + title: tax_region_id + description: The tax region id's details. + - type: object + description: The tax rate's tax region id. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: is_default + in: query + required: false + schema: + type: string + enum: + - 'true' + - 'false' + - name: created_at + in: query + description: The tax rate's created at. + required: false + schema: + type: object + description: The tax rate's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The tax rate's updated at. + required: false + schema: + type: object + description: The tax rate's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The tax rate's deleted at. + required: false + schema: + type: object + description: The tax rate's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -4836,6 +36704,8 @@ paths: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4848,16 +36718,58 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostTaxRates summary: Create Tax Rate description: Create a tax rate. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4866,7 +36778,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostTaxRatesReq' + $ref: '#/components/schemas/AdminCreateTaxRate' x-codeSamples: - lang: Shell label: cURL @@ -4875,12 +36787,15 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "name": "Emilio", - "tax_region_id": "{value}" + "name": "Kaylin", + "tax_region_id": "{value}", + "metadata": {} }' tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4906,6 +36821,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4919,6 +36880,8 @@ paths: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4931,10 +36894,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostTaxRatesId summary: Update a Tax Rate @@ -4947,6 +36906,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4955,16 +36960,22 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostTaxRatesTaxRateReq' + $ref: '#/components/schemas/AdminUpdateTaxRate' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/tax-rates/{id}' \ - -H 'x-medusa-access-token: {api_token}' + -H 'x-medusa-access-token: {api_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {} + }' tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -4989,6 +37000,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5002,6 +37059,8 @@ paths: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5014,10 +37073,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/tax-rates/{id}/rules: post: operationId: PostTaxRatesIdRules @@ -5031,6 +37086,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5039,7 +37140,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostTaxRatesTaxRateRulesReq' + $ref: '#/components/schemas/AdminCreateTaxRateRule' x-codeSamples: - lang: Shell label: cURL @@ -5054,6 +37155,8 @@ paths: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5085,6 +37188,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5098,6 +37247,8 @@ paths: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5110,17 +37261,407 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/tax-regions: + get: + operationId: GetTaxRegions + summary: List Tax Regions + description: Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The tax region's q. + required: false + schema: + type: string + title: q + description: The tax region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The tax region's ID. + - type: array + description: The tax region's ID. + items: + type: string + title: id + description: The id's ID. + - name: country_code + in: query + required: false + schema: + oneOf: + - type: string + title: country_code + description: The tax region's country code. + - type: array + description: The tax region's country code. + items: + type: string + title: country_code + description: The country code's details. + - type: object + description: The tax region's country code. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: province_code + in: query + required: false + schema: + oneOf: + - type: string + title: province_code + description: The tax region's province code. + - type: array + description: The tax region's province code. + items: + type: string + title: province_code + description: The province code's details. + - type: object + description: The tax region's province code. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: parent_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_id + description: The tax region's parent id. + - type: array + description: The tax region's parent id. + items: + type: string + title: parent_id + description: The parent id's details. + - type: object + description: The tax region's parent id. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: created_by + in: query + required: false + schema: + oneOf: + - type: string + title: created_by + description: The tax region's created by. + - type: array + description: The tax region's created by. + items: + type: string + title: created_by + description: The created by's details. + - name: created_at + in: query + description: The tax region's created at. + required: false + schema: + type: object + description: The tax region's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The tax region's updated at. + required: false + schema: + type: object + description: The tax region's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The tax region's deleted at. + required: false + schema: + type: object + description: The tax region's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/tax-regions' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Tax Regions + 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' post: operationId: PostTaxRegions summary: Create Tax Region description: Create a tax region. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5129,7 +37670,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostTaxRegionsReq' + $ref: '#/components/schemas/AdminCreateTaxRegion' x-codeSamples: - lang: Shell label: cURL @@ -5138,11 +37679,16 @@ paths: -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "country_code": "{value}" + "country_code": "{value}", + "province_code": "{value}", + "parent_id": "{value}", + "metadata": {} }' tags: - Tax Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5156,6 +37702,91 @@ paths: '500': $ref: '#/components/responses/500_error' /admin/tax-regions/{id}: + get: + operationId: GetTaxRegionsId + summary: Get a Tax Region + description: Retrieve a tax region by its ID. You can expand the tax region's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The tax region's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/tax-regions/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Tax Regions + 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' delete: operationId: DeleteTaxRegionsId summary: Delete a Tax Region @@ -5168,6 +37799,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5181,6 +37858,8 @@ paths: tags: - Tax Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5193,171 +37872,59 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /admin/users: - get: - operationId: GetUsers - summary: List Users - description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl '{backend_url}/admin/users' \ - -H 'x-medusa-access-token: {api_token}' - tags: - - Users - responses: - '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' - requestBody: - content: - application/json: - schema: {} + /admin/uploads: post: - operationId: PostUsers - summary: Create User - description: Create a user. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl -X POST '{backend_url}/admin/users' \ - -H 'x-medusa-access-token: {api_token}' - tags: - - Users - responses: - '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' - requestBody: - content: - application/json: - schema: {} - /admin/users/me: - get: - operationId: GetUsersMe - summary: List Users - description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl '{backend_url}/admin/users/me' \ - -H 'x-medusa-access-token: {api_token}' - tags: - - Users - responses: - '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' - requestBody: - content: - application/json: - schema: {} - /admin/users/{id}: - get: - operationId: GetUsersId - summary: Get a User - description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. + operationId: PostUploads + summary: Create Upload + description: Create a upload. x-authenticated: true parameters: - - name: id - in: path - description: The user's ID. - required: true + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: |- - curl '{backend_url}/admin/users/{id}' \ - -H 'x-medusa-access-token: {api_token}' - tags: - - Users - responses: - '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' - requestBody: - content: - application/json: - schema: {} - post: - operationId: PostUsersId - summary: Update a User - description: Update a user's details. - x-authenticated: true - parameters: - - name: id - in: path - description: The user's ID. - required: true + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false schema: type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5366,20 +37933,591 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminUpdateUserRequest' + $ref: '#/components/schemas/AdminGetUploadParams' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/uploads' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Uploads + 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' + /admin/uploads/{id}: + get: + operationId: GetUploadsId + summary: Get a Upload + description: Retrieve a upload by its ID. You can expand the upload's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The upload's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/uploads/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Uploads + 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' + delete: + operationId: DeleteUploadsId + summary: Delete a Upload + description: Delete a upload. + x-authenticated: true + parameters: + - name: id + in: path + description: The upload's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X DELETE '{backend_url}/admin/uploads/{id}' \ + -H 'x-medusa-access-token: {api_token}' + tags: + - Uploads + 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' + /admin/users: + get: + operationId: GetUsers + summary: List Users + description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/admin/users' + tags: + - Users + 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' + post: + operationId: PostUsers + summary: Create User + description: Create a user. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateUser' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/users' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "email": "Janie42@hotmail.com" + }' + tags: + - Users + 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' + /admin/users/me: + get: + operationId: GetUsersMe + summary: List Users + description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/admin/users/me' + tags: + - Users + 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' + /admin/users/{id}: + get: + operationId: GetUsersId + summary: Get a User + description: Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The user's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/admin/users/{id}' + tags: + - Users + 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' + post: + operationId: PostUsersId + summary: Update a User + description: Update a user's details. + x-authenticated: false + parameters: + - name: id + in: path + description: The user's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateUser' x-codeSamples: - lang: Shell label: cURL source: |- curl -X POST '{backend_url}/admin/users/{id}' \ - -H 'x-medusa-access-token: {api_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ + "first_name": "{value}", + "last_name": "{value}", "avatar_url": "{value}" }' tags: - Users responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5396,7 +38534,7 @@ paths: operationId: DeleteUsersId summary: Delete a User description: Delete a user. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -5404,19 +38542,61 @@ paths: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: |- - curl -X DELETE '{backend_url}/admin/users/{id}' \ - -H 'x-medusa-access-token: {api_token}' + source: curl -X DELETE '{backend_url}/admin/users/{id}' tags: - Users responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5429,17 +38609,87 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/workflows-executions: get: operationId: GetWorkflowsExecutions summary: List Workflows Executions description: Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as `id`. The workflows executions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: transaction_id + in: query + required: false + schema: + oneOf: + - type: string + title: transaction_id + description: The workflows execution's transaction id. + - type: array + description: The workflows execution's transaction id. + items: + type: string + title: transaction_id + description: The transaction id's details. + - name: workflow_id + in: query + required: false + schema: + oneOf: + - type: string + title: workflow_id + description: The workflows execution's workflow id. + - type: array + description: The workflows execution's workflow id. + items: + type: string + title: workflow_id + description: The workflow id's details. security: - api_token: [] - cookie_auth: [] @@ -5453,6 +38703,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5465,10 +38717,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/workflows-executions/{id}: get: operationId: GetWorkflowsExecutionsId @@ -5482,6 +38730,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5495,6 +38789,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5507,10 +38803,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/workflows-executions/{workflow_id}/run: post: operationId: PostWorkflowsExecutionsWorkflow_idRun @@ -5524,6 +38816,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5532,7 +38870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostWorkflowsRunReq' + $ref: '#/components/schemas/AdminCreateWorkflowsRun' x-codeSamples: - lang: Shell label: cURL @@ -5542,6 +38880,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5567,6 +38907,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5575,7 +38961,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostWorkflowsAsyncResponseReq' + $ref: '#/components/schemas/AdminCreateWorkflowsAsyncResponse' x-codeSamples: - lang: Shell label: cURL @@ -5590,6 +38976,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5615,6 +39003,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5623,7 +39057,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminPostWorkflowsAsyncResponseReq' + $ref: '#/components/schemas/AdminCreateWorkflowsAsyncResponse' x-codeSamples: - lang: Shell label: cURL @@ -5638,6 +39072,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5663,6 +39099,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5676,6 +39158,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5688,10 +39172,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/workflows-executions/{workflow_id}/{transaction_id}: get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_id @@ -5711,6 +39191,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5724,6 +39250,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5736,10 +39264,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/workflows-executions/{workflow_id}/{transaction_id}/{step_id}/subscribe: get: operationId: GetWorkflowsExecutionsWorkflow_idTransaction_idStep_idSubscribe @@ -5765,6 +39289,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5778,6 +39348,8 @@ paths: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -5790,10 +39362,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} components: responses: default_error: @@ -5836,20 +39404,16 @@ components: message: Entity with id 1 was not found type: not_found 400_error: - description: Client Error or Multiple Errors + description: Client Error content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/Error' - - $ref: '#/components/schemas/MultipleErrors' + $ref: '#/components/schemas/Error' examples: not_allowed: $ref: '#/components/examples/not_allowed_error' invalid_data: $ref: '#/components/examples/invalid_data_error' - MultipleErrors: - $ref: '#/components/examples/multiple_errors' 500_error: description: Server Error content: @@ -5939,1282 +39503,554 @@ components: name: connect.sid x-displayName: Cookie Session ID schemas: - AdminDeletePricingRuleTypesRuleTypeReq: + AdminArchiveOrder: type: object description: SUMMARY - x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq - properties: {} - AdminGetPricingRuleTypesParams: - type: object - description: SUMMARY - x-schemaName: AdminGetPricingRuleTypesParams + x-schemaName: AdminArchiveOrder + required: + - order_id properties: - rule_attribute: + order_id: + type: string + title: order_id + description: The order's order id. + AdminBatchProductRequest: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductRequest + properties: + create: type: array - description: The pricing's rule attribute. + description: The product's create. + items: + $ref: '#/components/schemas/AdminCreateProduct' + update: + type: array + description: The product's update. + items: + $ref: '#/components/schemas/AdminUpdateProduct' + delete: + type: array + description: The product's delete. items: type: string - title: rule_attribute - description: The rule attribute's details. - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - offset: - type: number - title: offset - description: The pricing's offset. - limit: - type: number - title: limit - description: The pricing's limit. - order: - type: string - title: order - description: The pricing's order. - AdminGetPricingRuleTypesRuleTypeParams: + title: delete + description: The delete's details. + AdminBatchProductResponse: type: object description: SUMMARY - x-schemaName: AdminGetPricingRuleTypesRuleTypeParams + x-schemaName: AdminBatchProductResponse + required: + - created + - updated + - deleted properties: - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - AdminGetProductsParams: - type: object - description: SUMMARY - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. + created: + type: array + description: The product's created. + items: + $ref: '#/components/schemas/AdminProduct' + updated: + type: array + description: The product's updated. + items: + $ref: '#/components/schemas/AdminProduct' + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. items: type: string - title: id - description: The id's ID. - status: + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminBatchProductVariantRequest: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductVariantRequest + properties: + create: type: array - description: The product's status. - items: {} + description: The product's create. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + update: + type: array + description: The product's update. + items: + $ref: '#/components/schemas/AdminUpdateProductVariant' + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. + AdminBatchProductVariantResponse: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductVariantResponse + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The product's created. + items: + $ref: '#/components/schemas/AdminProductVariant' + updated: + type: array + description: The product's updated. + items: + $ref: '#/components/schemas/AdminProductVariant' + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminCancelFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminCancelFulfillment + AdminCollection: + type: object + description: The parent's collection. + x-schemaName: AdminCollection + properties: + id: + type: string + title: id + description: The collection's ID. title: type: string title: title - description: The product's title. + description: The collection's title. handle: type: string title: handle - description: The product's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - price_list_id: + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: type: array - description: The product's price list id. + description: The collection's products. items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The product's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The product's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: + type: object + metadata: type: object - description: The product's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The product's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The product's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The product's expand. - fields: - type: string - title: fields - description: The product's fields. - offset: - type: number - title: offset - description: The product's offset. - limit: - type: number - title: limit - description: The product's limit. - order: - type: string - title: order - description: The product's order. - AdminGetPromotionsParams: + description: The collection's metadata. + AdminCompleteOrder: type: object description: SUMMARY - x-schemaName: AdminGetPromotionsParams + x-schemaName: AdminCompleteOrder + required: + - order_id properties: - code: + order_id: type: string - title: code - description: The promotion's code. - expand: - type: string - title: expand - description: The promotion's expand. - fields: - type: string - title: fields - description: The promotion's fields. - offset: - type: number - title: offset - description: The promotion's offset. - limit: - type: number - title: limit - description: The promotion's limit. - order: - type: string - title: order - description: The promotion's order. - AdminPostCampaignsReq: + title: order_id + description: The order's order id. + AdminCreateApiKey: type: object - description: The promotion's campaign. - x-schemaName: AdminPostCampaignsReq + description: SUMMARY + x-schemaName: AdminCreateApiKey + required: + - title + - type + properties: + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - publishable + - secret + AdminCreateCollection: + type: object + description: SUMMARY + x-schemaName: AdminCreateCollection + required: + - title + - metadata + properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. + AdminCreateCustomer: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminCreateCustomerAddress: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomerAddress + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminCreateCustomerGroup: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomerGroup required: - name + - metadata properties: name: type: string title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. - budget: - $ref: '#/components/schemas/CampaignBudget' - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - x-schemaName: IdObject - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - AdminPostCustomerGroupsGroupCustomersBatchReq: + description: The customer group's name. + metadata: + type: object + description: The customer group's metadata. + AdminCreateFulfillment: type: object description: SUMMARY - x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq - required: - - customer_ids - properties: - customer_ids: - type: array - description: The customer group's customer ids. - items: - type: object - description: The customer id's customer ids. - x-schemaName: CustomerGroupsBatchCustomer - required: - - id - properties: - id: - type: string - title: id - description: The customer id's ID. - AdminPostFulfillmentShippingOptionsRulesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq - required: - - rules - properties: - rules: - type: array - description: The fulfillment's rules. - items: - type: object - description: The rule's rules. - x-schemaName: FulfillmentRuleCreate - required: - - operator - - attribute - - value - properties: - operator: {} - 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. - AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq - required: - - rule_ids - properties: - rule_ids: - type: array - description: The fulfillment's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. - AdminPostInventoryItemsInventoryItemReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsInventoryItemReq - properties: - sku: - type: string - title: sku - description: The inventory item's sku. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - 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. - weight: - type: number - title: weight - description: The inventory item's weight. - height: - type: number - title: height - description: The inventory item's height. - length: - type: number - title: length - description: The inventory item's length. - width: - type: number - title: width - description: The inventory item's width. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. - AdminPostInventoryItemsItemLocationLevelsLevelReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq - properties: - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - AdminPostInventoryItemsItemLocationLevelsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq + x-schemaName: AdminCreateFulfillment required: - location_id - - stocked_quantity + - provider_id + - delivery_address + - items + - labels + - order + - order_id + - shipping_option_id + - data + - packed_at + - shipped_at + - delivered_at + - canceled_at + - metadata properties: location_id: type: string title: location_id - description: The inventory item's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - AdminPostInventoryItemsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsReq - properties: - sku: + description: The fulfillment's location id. + provider_id: type: string - title: sku - description: The inventory item's sku. - hs_code: + title: provider_id + description: The fulfillment's provider id. + delivery_address: + type: object + description: The fulfillment's delivery address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + phone: + type: string + title: phone + description: The delivery address's phone. + company: + type: string + title: company + description: The delivery address's company. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + metadata: + type: object + description: The delivery address's metadata. + items: + type: array + description: The fulfillment's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - quantity + - barcode + - line_item_id + - inventory_item_id + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + quantity: + type: number + title: quantity + description: The item's quantity. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + order: + type: object + description: The fulfillment's order. + order_id: 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: + title: order_id + description: The fulfillment's order id. + shipping_option_id: type: string - title: origin_country - description: The inventory item's origin country. - mid_code: + title: shipping_option_id + description: The fulfillment's shipping option id. + data: + type: object + description: The fulfillment's data. + packed_at: type: string - title: mid_code - description: The inventory item's mid code. - material: + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: type: string - title: material - description: The inventory item's material. - title: + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: type: string - title: title - description: The inventory item's title. - description: + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. + title: canceled_at + description: The fulfillment's canceled at. + format: date-time metadata: type: object - description: The inventory item's metadata. - properties: {} - AdminPostInvitesInviteAcceptReq: + description: The fulfillment's metadata. + AdminCreatePriceList: type: object description: SUMMARY - x-schemaName: AdminPostInvitesInviteAcceptReq - required: - - first_name - - last_name - properties: - first_name: - type: string - title: first_name - description: The invite's first name. - last_name: - type: string - title: last_name - description: The invite's last name. - AdminPostPaymentsCapturesReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPaymentsCapturesReq - properties: - amount: - type: number - title: amount - description: The payment's amount. - AdminPostPaymentsRefundsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPaymentsRefundsReq - properties: - amount: - type: number - title: amount - description: The payment's amount. - AdminPostPriceListsPriceListPricesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq - required: - - prices - properties: - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - AdminPostPriceListsPriceListPricesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq - required: - - ids - properties: - ids: - type: array - description: The price list's ids. - items: - type: string - title: ids - description: The id's ids. - AdminPostPriceListsPriceListReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListReq - required: - - prices - properties: - title: - type: string - title: title - description: The price list's title. - description: - type: string - title: description - description: The price list's description. - starts_at: - type: string - title: starts_at - description: The price list's starts at. - ends_at: - type: string - title: ends_at - description: The price list's ends at. - status: {} - type: {} - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} - AdminPostPriceListsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsReq + x-schemaName: AdminCreatePriceList required: - title - description - - type - - prices + - starts_at + - ends_at properties: title: type: string @@ -7232,19 +40068,31 @@ components: type: string title: ends_at description: The price list's ends at. - status: {} - type: {} + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. prices: type: array description: The price list's prices. items: type: object description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq required: - currency_code - amount - variant_id + - min_quantity + - max_quantity properties: currency_code: type: string @@ -7269,200 +40117,393 @@ components: rules: type: object description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} - AdminPostPricingRuleTypesReq: + AdminCreateProduct: type: object - description: SUMMARY - x-schemaName: AdminPostPricingRuleTypesReq + description: The create's details. + x-schemaName: AdminCreateProduct required: - - name - - rule_attribute - - default_priority + - title properties: - name: + title: type: string - title: name - description: The pricing's name. - rule_attribute: + title: title + description: The create's title. + subtitle: type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. - AdminPostPricingRuleTypesRuleTypeReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPricingRuleTypesRuleTypeReq - properties: - name: + title: subtitle + description: The create's subtitle. + description: type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. - AdminPostPromotionsPromotionReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionReq - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: + title: description + description: The create's description. + is_giftcard: type: boolean - title: is_automatic - description: The promotion's is automatic. - type: {} - campaign_id: + title: is_giftcard + description: The create's is giftcard. + discountable: + type: boolean + title: discountable + description: The create's discountable. + images: + type: array + description: The create's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - $ref: '#/components/schemas/AdminPostCampaignsReq' - application_method: - $ref: '#/components/schemas/ApplicationMethodsMethodPostReq' - rules: + title: thumbnail + description: The create's thumbnail. + handle: + type: string + title: handle + description: The create's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The create's type id. + collection_id: + type: string + title: collection_id + description: The create's collection id. + categories: type: array - description: The promotion's rules. + description: The create's categories. items: type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostPromotionsPromotionRulesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq - required: - - rules - properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostPromotionsPromotionRulesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq - required: - - rule_ids - properties: - rule_ids: - type: array - description: The promotion's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. - AdminPostPromotionsPromotionRulesBatchUpdateReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq - required: - - rules - properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: UpdatePromotionRule + description: The category's categories. required: - id - - attribute - - values properties: id: type: string title: id - description: The rule's ID. - operator: {} - description: + description: The category's ID. + tags: + type: array + description: The create's tags. + items: + type: object + description: The tag's tags. + properties: + id: type: string - title: description - description: The rule's description. - attribute: + title: id + description: The tag's ID. + value: type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostStockLocationsReq: + title: value + description: The tag's value. + options: + type: array + description: The create's options. + items: + $ref: '#/components/schemas/AdminCreateProductOption' + variants: + type: array + description: The create's variants. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + sales_channels: + type: array + description: The create's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + AdminCreateProductOption: type: object description: SUMMARY - x-schemaName: AdminPostStockLocationsReq + x-schemaName: AdminCreateProductOption + required: + - title + - values + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. + AdminCreateProductVariant: + type: object + description: The create's details. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The create's title. + sku: + type: string + title: sku + description: The create's sku. + ean: + type: string + title: ean + description: The create's ean. + upc: + type: string + title: upc + description: The create's upc. + barcode: + type: string + title: barcode + description: The create's barcode. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The create's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The create's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The create's variant rank. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + prices: + type: array + description: The create's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The create's options. + AdminCreateProductVariantPrice: + type: object + description: The price's prices. + x-schemaName: AdminCreateProductVariantPrice + 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. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + AdminCreateSalesChannel: + type: object + description: SUMMARY + x-schemaName: AdminCreateSalesChannel required: - name + - description + - metadata + properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + AdminCreateShipment: + type: object + description: SUMMARY + x-schemaName: AdminCreateShipment + required: + - labels + properties: + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + AdminCreateStockLocation: + type: object + description: SUMMARY + x-schemaName: AdminCreateStockLocation + required: + - name + - address_id + - metadata properties: name: type: string title: name description: The stock location's name. address: - $ref: '#/components/schemas/StockLocationAddress' + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. address_id: type: string title: address_id @@ -7470,14 +40511,14 @@ components: metadata: type: object description: The stock location's metadata. - properties: {} - AdminPostTaxRatesReq: + AdminCreateTaxRate: type: object description: SUMMARY - x-schemaName: AdminPostTaxRatesReq + x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - metadata properties: rate: type: number @@ -7493,7 +40534,6 @@ components: items: type: object description: The rule's rules. - x-schemaName: CreateTaxRateRule required: - reference - reference_id @@ -7525,53 +40565,10 @@ components: metadata: type: object description: The tax rate's metadata. - properties: {} - AdminPostTaxRatesTaxRateReq: + AdminCreateTaxRateRule: type: object description: SUMMARY - x-schemaName: AdminPostTaxRatesTaxRateReq - properties: - code: - type: string - title: code - description: The tax rate's code. - name: - type: string - title: name - description: The tax rate's name. - region_id: - type: string - title: region_id - description: The tax rate's region id. - rate: - type: number - title: rate - description: The tax rate's rate. - products: - type: array - description: The tax rate's products. - items: - type: string - title: products - description: The product's products. - shipping_options: - type: array - description: The tax rate's shipping options. - items: - type: string - title: shipping_options - description: The shipping option's shipping options. - product_types: - type: array - description: The tax rate's product types. - items: - type: string - title: product_types - description: The product type's product types. - AdminPostTaxRatesTaxRateRulesReq: - type: object - description: SUMMARY - x-schemaName: AdminPostTaxRatesTaxRateRulesReq + x-schemaName: AdminCreateTaxRateRule required: - reference - reference_id @@ -7584,12 +40581,15 @@ components: type: string title: reference_id description: The tax rate's reference id. - AdminPostTaxRegionsReq: + AdminCreateTaxRegion: type: object description: SUMMARY - x-schemaName: AdminPostTaxRegionsReq + x-schemaName: AdminCreateTaxRegion required: - country_code + - province_code + - parent_id + - metadata properties: country_code: type: string @@ -7604,15 +40604,55 @@ components: title: parent_id description: The tax region's parent id. default_tax_rate: - $ref: '#/components/schemas/CreateDefaultTaxRate' + type: object + description: The tax region's default tax rate. + required: + - name + - metadata + properties: + rate: + type: number + title: rate + description: The default tax rate's rate. + code: + type: string + title: code + description: The default tax rate's code. + name: + type: string + title: name + description: The default tax rate's name. + is_combinable: + type: string + enum: + - 'true' + - 'false' + metadata: + type: object + description: The default tax rate's metadata. metadata: type: object description: The tax region's metadata. - properties: {} - AdminPostWorkflowsAsyncResponseReq: + AdminCreateVariantInventoryItem: type: object description: SUMMARY - x-schemaName: AdminPostWorkflowsAsyncResponseReq + x-schemaName: AdminCreateVariantInventoryItem + required: + - required_quantity + - inventory_item_id + properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The product's inventory item id. + AdminCreateWorkflowsAsyncResponse: + type: object + description: SUMMARY + x-schemaName: AdminCreateWorkflowsAsyncResponse required: - transaction_id - step_id @@ -7627,22 +40667,2151 @@ components: description: The workflows execution's step id. response: {} compensate_input: {} - action: {} - AdminPostWorkflowsRunReq: + action: + type: string + enum: + - invoke + - compensate + AdminCreateWorkflowsRun: type: object description: SUMMARY - x-schemaName: AdminPostWorkflowsRunReq + x-schemaName: AdminCreateWorkflowsRun properties: input: {} transaction_id: type: string title: transaction_id description: The workflows execution's transaction id. - AdminUpdateUserRequest: + AdminCustomer: + type: object + description: The customer's details. + x-schemaName: AdminCustomer + required: + - has_account + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses + properties: + has_account: + type: boolean + title: has_account + description: The customer's has account. + groups: + type: array + description: The customer's groups. + items: + $ref: '#/components/schemas/AdminCustomerGroup' + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/BaseCustomerAddress' + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. + AdminCustomerGroup: + type: object + description: The group's groups. + x-schemaName: AdminCustomerGroup + required: + - id + - name + - customers + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The group's ID. + name: + type: string + title: name + description: The group's name. + customers: + type: array + description: The group's customers. + items: + $ref: '#/components/schemas/BaseCustomer' + metadata: + type: object + description: The group's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The group's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The group's updated at. + AdminFulfillmentProvider: + type: object + description: The shipping option's provider. + x-schemaName: AdminFulfillmentProvider + AdminFulfillmentSet: + type: object + description: The fulfillment set's details. + x-schemaName: AdminFulfillmentSet + required: + - id + - name + - type + - service_zones + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + name: + type: string + title: name + description: The fulfillment set's name. + type: + type: string + title: type + description: The fulfillment set's type. + service_zones: + type: array + description: The fulfillment set's service zones. + items: + $ref: '#/components/schemas/AdminServiceZone' + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment set's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment set's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment set's deleted at. + AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY - x-schemaName: AdminUpdateUserRequest + x-schemaName: AdminFulfillmentSetDeleteResponse required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + default: fulfillment_set + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. + AdminFulfillmentSetResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentSetResponse + required: + - fulfillment_set + properties: + fulfillment_set: + $ref: '#/components/schemas/AdminFulfillmentSet' + AdminGeoZone: + type: object + description: The geo zone's geo zones. + x-schemaName: AdminGeoZone + AdminGetUploadParams: + type: object + description: SUMMARY + x-schemaName: AdminGetUploadParams + properties: + fields: + type: string + title: fields + description: The upload's fields. + AdminOrderCancelFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCancelFulfillment + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + AdminOrderCreateFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCreateFulfillment + required: + - items + - location_id + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + AdminOrderCreateShipment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCreateShipment + required: + - items + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + AdminPostReceiveReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReceiveReturnsReqSchema + required: + - return_id + - items + - internal_note + properties: + return_id: + type: string + title: return_id + description: The return's return id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReqSchema + required: + - order_id + - items + - return_shipping + - internal_note + - location_id + properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + internal_note: + type: string + title: internal_note + description: The return's internal note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + location_id: + type: string + title: location_id + description: The return's location id. + AdminPrice: + type: object + description: The price's prices. + x-schemaName: AdminPrice + required: + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. + AdminProduct: + type: object + description: The product's parent. + x-schemaName: AdminProduct + required: + - type + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id + properties: + collection: + $ref: '#/components/schemas/AdminCollection' + categories: + type: array + description: The parent's categories. + items: + $ref: '#/components/schemas/AdminProductCategory' + sales_channels: + type: array + description: The parent's sales channels. + items: + $ref: '#/components/schemas/AdminSalesChannel' + variants: + type: array + description: The parent's variants. + items: + $ref: '#/components/schemas/AdminProductVariant' + type: + type: object + title: + type: string + title: title + description: The parent's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The parent's length. + options: + type: array + description: The parent's options. + items: + $ref: '#/components/schemas/BaseProductOption' + description: + type: string + title: description + description: The parent's description. + id: + type: string + title: id + description: The parent's ID. + handle: + type: string + title: handle + description: The parent's handle. + metadata: + type: object + description: The parent's metadata. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + width: + type: number + title: width + description: The parent's width. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. + subtitle: + type: string + title: subtitle + description: The parent's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The parent's is giftcard. + collection_id: + type: string + title: collection_id + description: The parent's collection id. + type_id: + type: string + title: type_id + description: The parent's type id. + tags: + type: array + description: The parent's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + images: + type: array + description: The parent's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The parent's discountable. + external_id: + type: string + title: external_id + description: The parent's external id. + AdminProductCategory: + type: object + description: The category's categories. + x-schemaName: AdminProductCategory + required: + - category_children + - parent_category + - name + - description + - id + - handle + - created_at + - updated_at + - deleted_at + - parent_category_id + - is_internal + - is_active + - rank + properties: + category_children: + type: array + description: The category's category children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + handle: + type: string + title: handle + description: The category's handle. + created_at: + type: string + format: date-time + title: created_at + description: The category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The category's deleted at. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. + is_active: + type: boolean + title: is_active + description: The category's is active. + rank: + type: number + title: rank + description: The category's rank. + AdminProductCategoryListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryListResponse + required: + - limit + - offset + - count + - product_categories + properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: '#/components/schemas/AdminProductCategory' + AdminProductCategoryResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryResponse + required: + - product_category + properties: + product_category: + $ref: '#/components/schemas/AdminProductCategory' + AdminProductDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + type: object + description: The product's parent. + AdminProductOption: + type: object + description: The product's product option. + x-schemaName: AdminProductOption + required: + - id + - title + properties: + id: + type: string + title: id + description: The product option's ID. + title: + type: string + title: title + description: The product option's title. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The product option's product id. + values: + type: array + description: The product option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + metadata: + type: object + description: The product option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product option's deleted at. + AdminProductOptionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductOptionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product_option + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProduct' + AdminProductOptionResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductOptionResponse + required: + - product_option + properties: + product_option: + $ref: '#/components/schemas/AdminProductOption' + AdminProductResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductResponse + required: + - product + properties: + product: + $ref: '#/components/schemas/AdminProduct' + AdminProductVariant: + type: object + description: The updated's details. + x-schemaName: AdminProductVariant + required: + - prices + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at + properties: + prices: + type: array + description: The updated's prices. + items: + $ref: '#/components/schemas/AdminPrice' + id: + type: string + title: id + description: The updated's ID. + title: + type: string + title: title + description: The updated's title. + sku: + type: string + title: sku + description: The updated's sku. + barcode: + type: string + title: barcode + description: The updated's barcode. + ean: + type: string + title: ean + description: The updated's ean. + upc: + type: string + title: upc + description: The updated's upc. + allow_backorder: + type: boolean + title: allow_backorder + description: The updated's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The updated's manage inventory. + hs_code: + type: string + title: hs_code + description: The updated's hs code. + origin_country: + type: string + title: origin_country + description: The updated's origin country. + mid_code: + type: string + title: mid_code + description: The updated's mid code. + material: + type: string + title: material + description: The updated's material. + weight: + type: number + title: weight + description: The updated's weight. + length: + type: number + title: length + description: The updated's length. + height: + type: number + title: height + description: The updated's height. + width: + type: number + title: width + description: The updated's width. + options: + type: array + description: The updated's options. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The updated's product id. + variant_rank: + type: number + title: variant_rank + description: The updated's variant rank. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. + metadata: + type: object + description: The updated's metadata. + AdminProductVariantDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: variant + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProduct' + AdminProductVariantParams: + type: object + description: The product's variants. + x-schemaName: AdminProductVariantParams + properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant's fields. + $and: + type: array + description: The variant's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $and's sku. + - type: array + description: The $and's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $and's options. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + $or: + type: array + description: The variant's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $or's sku. + - type: array + description: The $or's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $or's options. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + AdminProductVariantResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantResponse + required: + - variant + properties: + variant: + $ref: '#/components/schemas/AdminProductVariant' + AdminRevokeApiKey: + type: object + description: SUMMARY + x-schemaName: AdminRevokeApiKey + properties: + revoke_in: + type: number + title: revoke_in + description: The api key's revoke in. + AdminSalesChannel: + type: object + description: The sales channel's sales channels. + x-schemaName: AdminSalesChannel + required: + - id + - name + - description + - is_disabled + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The sales channel's ID. + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The sales channel's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The sales channel's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The sales channel's deleted at. + AdminServiceZone: + type: object + description: The service zone's service zones. + x-schemaName: AdminServiceZone + required: + - id + - name + - fulfillment_set_id + - geo_zones + - shipping_options + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The service zone's ID. + name: + type: string + title: name + description: The service zone's name. + fulfillment_set_id: + type: string + title: fulfillment_set_id + description: The service zone's fulfillment set id. + geo_zones: + type: array + description: The service zone's geo zones. + items: + $ref: '#/components/schemas/AdminGeoZone' + shipping_options: + type: array + description: The service zone's shipping options. + items: + $ref: '#/components/schemas/AdminShippingOption' + created_at: + type: string + format: date-time + title: created_at + description: The service zone's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The service zone's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The service zone's deleted at. + AdminServiceZoneResponse: + type: object + description: SUMMARY + x-schemaName: AdminServiceZoneResponse + required: + - service_zone + properties: + service_zone: + $ref: '#/components/schemas/AdminServiceZone' + AdminShippingOption: + type: object + description: The shipping option's shipping options. + x-schemaName: AdminShippingOption + AdminShippingOptionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingOptionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The shipping option's ID. + object: + type: string + title: object + description: The shipping option's object. + default: shipping_option + deleted: + type: boolean + title: deleted + description: The shipping option's deleted. + parent: + type: object + description: The shipping option's parent. + AdminShippingOptionResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingOptionResponse + required: + - shipping_option + properties: + shipping_option: + $ref: '#/components/schemas/AdminShippingOption' + AdminShippingProfile: + type: object + description: The shipping option's shipping profile. + x-schemaName: AdminShippingProfile + AdminShippingProfileDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingProfileDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The shipping profile's ID. + object: + type: string + title: object + description: The shipping profile's object. + default: shipping_profile + deleted: + type: boolean + title: deleted + description: The shipping profile's deleted. + parent: + type: object + description: The shipping profile's parent. + AdminShippingProfileResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingProfileResponse + required: + - shipping_profile + properties: + shipping_profile: + $ref: '#/components/schemas/AdminShippingProfile' + AdminUpdateApiKey: + type: object + description: SUMMARY + x-schemaName: AdminUpdateApiKey + required: + - title + properties: + title: + type: string + title: title + description: The api key's title. + AdminUpdateCampaign: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCampaign + required: + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + properties: + limit: + type: number + title: limit + description: The budget's limit. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + AdminUpdateCollection: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCollection + required: + - metadata + properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. + AdminUpdateCustomer: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminUpdateCustomerGroup: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCustomerGroup + required: + - name + - metadata + properties: + name: + type: string + title: name + description: The customer group's name. + metadata: + type: object + description: The customer group's metadata. + AdminUpdatePriceList: + type: object + description: SUMMARY + x-schemaName: AdminUpdatePriceList + required: + - description + - starts_at + - ends_at + properties: + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. + AdminUpdateProduct: + type: object + description: The update's details. + x-schemaName: AdminUpdateProduct + properties: + title: + type: string + title: title + description: The update's title. + subtitle: + type: string + title: subtitle + description: The update's subtitle. + description: + type: string + title: description + description: The update's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The update's is giftcard. + discountable: + type: boolean + title: discountable + description: The update's discountable. + images: + type: array + description: The update's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The update's thumbnail. + handle: + type: string + title: handle + description: The update's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The update's type id. + collection_id: + type: string + title: collection_id + description: The update's collection id. + categories: + type: array + description: The update's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The update's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The update's options. + items: + $ref: '#/components/schemas/AdminUpdateProductOption' + variants: + type: array + description: The update's variants. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + sales_channels: + type: array + description: The update's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + AdminUpdateProductOption: + type: object + description: SUMMARY + x-schemaName: AdminUpdateProductOption + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. + AdminUpdateProductVariant: + type: object + description: The update's details. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The update's title. + sku: + type: string + title: sku + description: The update's sku. + ean: + type: string + title: ean + description: The update's ean. + upc: + type: string + title: upc + description: The update's upc. + barcode: + type: string + title: barcode + description: The update's barcode. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The update's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The update's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The update's variant rank. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + prices: + type: array + description: The update's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The update's options. + AdminUpdateSalesChannel: + type: object + description: SUMMARY + x-schemaName: AdminUpdateSalesChannel + required: + - description + - metadata + properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + AdminUpdateStockLocation: + type: object + description: SUMMARY + x-schemaName: AdminUpdateStockLocation + required: + - address_id + - metadata + properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. + AdminUpdateStore: + type: object + description: SUMMARY + x-schemaName: AdminUpdateStore + required: + - name + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + properties: + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + type: object + description: The supported currency's supported currencies. + required: + - currency_code + properties: + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + AdminUpdateTaxRate: + type: object + description: SUMMARY + x-schemaName: AdminUpdateTaxRate + required: + - metadata + properties: + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + rules: + type: array + description: The tax rate's rules. + items: + type: object + description: The rule's rules. + required: + - reference + - reference_id + properties: + reference: + type: string + title: reference + description: The rule's reference. + reference_id: + type: string + title: reference_id + description: The rule's reference id. + name: + type: string + title: name + description: The tax rate's name. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + metadata: + type: object + description: The tax rate's metadata. + AdminUpdateUser: + type: object + description: SUMMARY + x-schemaName: AdminUpdateUser + required: + - first_name + - last_name - avatar_url properties: first_name: @@ -7657,123 +42826,658 @@ components: type: string title: avatar_url description: The user's avatar url. - ApplicationMethodsMethodPostReq: + AdminUpdateVariantInventoryItem: type: object - description: The promotion's application method. - x-schemaName: ApplicationMethodsMethodPostReq + description: SUMMARY + x-schemaName: AdminUpdateVariantInventoryItem + required: + - required_quantity properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + BaseCollection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + BaseCustomer: + type: object + description: The customer's customers. + x-schemaName: BaseCustomer + BaseCustomerAddress: + type: object + description: The address's addresses. + x-schemaName: BaseCustomerAddress + required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The address's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The address's is default billing. + customer_id: + type: string + title: customer_id + description: The address's customer id. + company: + type: string + title: company + description: The address's company. + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + phone: + type: string + title: phone + description: The address's phone. + metadata: + type: object + description: The address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's updated at. + BaseProduct: + type: object + description: The updated's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - tags + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. description: type: string title: description - description: The application method's description. + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + $ref: '#/components/schemas/BaseCollection' + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + $ref: '#/components/schemas/BaseProductCategory' + type: + type: object + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/BaseProductVariant' + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/BaseProductOption' + images: + type: array + description: The product's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + BaseProductCategory: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + BaseProductImage: + type: object + description: The image's images. + x-schemaName: BaseProductImage + BaseProductOption: + type: object + description: The option's options. + x-schemaName: BaseProductOption + BaseProductOptionValue: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The option's ID. value: type: string title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - type: {} - target_type: {} - allocation: {} - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - CampaignBudget: - type: object - description: The campaign's budget. - x-schemaName: CampaignBudget - properties: - type: {} - limit: - type: number - title: limit - description: The budget's limit. - CreateDefaultTaxRate: - type: object - description: The tax region's default tax rate. - x-schemaName: CreateDefaultTaxRate - required: - - name - properties: - rate: - type: number - title: rate - description: The default tax rate's rate. - code: + description: The option's value. + option: + $ref: '#/components/schemas/BaseProductOption' + option_id: type: string - title: code - description: The default tax rate's code. - name: - type: string - title: name - description: The default tax rate's name. + title: option_id + description: The option's option id. metadata: type: object - description: The default tax rate's metadata. - properties: {} + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. + BaseProductTag: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + BaseProductVariant: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + CreateAddress: + type: object + description: The cart's shipping address. + x-schemaName: CreateAddress + properties: + customer_id: + type: string + title: customer_id + description: The shipping address's customer id. + company: + type: string + title: company + description: The shipping address's company. + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + phone: + type: string + title: phone + description: The shipping address's phone. + metadata: + type: object + description: The shipping address's metadata. + CreateCartAddress: + type: object + description: The cart's billing address. + x-schemaName: CreateCartAddress + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + CreateCartCreateLineItem: + type: object + description: The item's items. + x-schemaName: CreateCartCreateLineItem + required: + - quantity + - variant_id + properties: + quantity: + type: string + title: quantity + description: The item's quantity. + variant_id: + type: string + title: variant_id + description: The item's variant id. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + is_giftcard: + type: boolean + title: is_giftcard + description: The item's is giftcard. + compare_at_unit_price: + type: string + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: string + title: unit_price + description: The item's unit price. + metadata: + type: object + description: The item's metadata. + CreateCartWorkflowInput: + type: object + description: SUMMARY + x-schemaName: CreateCartWorkflowInput + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: '#/components/schemas/CreateCartAddress' + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: '#/components/schemas/CreateCartAddress' + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/CreateCartCreateLineItem' + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + CreateOrderReturnReason: + type: object + description: SUMMARY + x-schemaName: CreateOrderReturnReason + required: + - value + - label + properties: + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + metadata: + type: object + description: The return reason's metadata. + CreateUser: + type: object + description: SUMMARY + x-schemaName: CreateUser + required: + - email + properties: + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. Error: title: Response Error type: object @@ -7808,76 +43512,578 @@ components: - unexpected_state - invalid_argument - unknown_error - MultipleErrors: - title: Multiple Errors + StoreAddCartLineItem: type: object - properties: - errors: - type: array - description: Array of errors - items: - $ref: '#/components/schemas/Error' - message: - type: string - default: Provided request body contains errors. Please check the data and retry the request - StockLocationAddress: - type: object - description: The stock location's address. - x-schemaName: StockLocationAddress + description: SUMMARY + x-schemaName: StoreAddCartLineItem required: - - address_1 - - country_code + - variant_id + - quantity + - metadata properties: - address_1: + variant_id: type: string - title: address_1 - description: The address's address 1. - address_2: + title: variant_id + description: The cart's variant id. + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. + StoreCalculateCartTaxes: + type: object + description: SUMMARY + x-schemaName: StoreCalculateCartTaxes + properties: + fields: type: string - title: address_2 - description: The address's address 2. - company: + title: fields + description: The cart's fields. + StoreCreateCustomer: + type: object + description: SUMMARY + x-schemaName: StoreCreateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + properties: + email: type: string - title: company - description: The address's company. - city: + title: email + description: The customer's email. + format: email + company_name: type: string - title: city - description: The address's city. - country_code: + title: company_name + description: The customer's company name. + first_name: type: string - title: country_code - description: The address's country code. + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. phone: type: string title: phone - description: The address's phone. - postal_code: + description: The customer's phone. + StorePostReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: StorePostReturnsReqSchema + required: + - order_id + - items + - return_shipping + - note + - location_id + properties: + order_id: type: string - title: postal_code - description: The address's postal code. + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. + StoreProduct: + type: object + description: The product's products. + x-schemaName: StoreProduct + required: + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - variants + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id + properties: + categories: + type: array + description: The product's categories. + items: + type: object + type: + type: object + title: + type: string + title: title + description: The product's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The product's length. + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/BaseProductOption' + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + handle: + type: string + title: handle + description: The product's handle. + metadata: + type: object + description: The product's metadata. + hs_code: + type: string + title: hs_code + description: The product's hs code. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/BaseProductVariant' + subtitle: + type: string + title: subtitle + description: The product's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + collection: + $ref: '#/components/schemas/BaseCollection' + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + images: + type: array + description: The product's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + StoreProductCategory: + type: object + description: The product category's details. + x-schemaName: StoreProductCategory + required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at + properties: + products: + type: array + description: The product category's products. + items: + $ref: '#/components/schemas/StoreProduct' + id: + type: string + title: id + description: The product category's ID. + 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_active: + type: boolean + title: is_active + description: The product category's is active. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + rank: + type: number + title: rank + description: The product category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The product category's parent category id. + parent_category: + $ref: '#/components/schemas/BaseProductCategory' + category_children: + type: array + description: The product category's category children. + items: + $ref: '#/components/schemas/BaseProductCategory' + created_at: + type: string + format: date-time + title: created_at + description: The product category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product category's deleted at. + StoreProductCategoryListResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductCategoryListResponse + required: + - limit + - offset + - count + - product_categories + properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: '#/components/schemas/StoreProductCategory' + StoreProductCategoryResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductCategoryResponse + required: + - product_category + properties: + product_category: + $ref: '#/components/schemas/StoreProductCategory' + StoreUpdateCartLineItem: + type: object + description: SUMMARY + x-schemaName: StoreUpdateCartLineItem + required: + - quantity + - metadata + properties: + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. + StoreUpdateCustomer: + type: object + description: SUMMARY + x-schemaName: StoreUpdateCustomer + required: + - company_name + - first_name + - last_name + - phone + properties: + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + UpdateAddress: + type: object + description: The cart's shipping address. + x-schemaName: UpdateAddress + required: + - id + properties: + id: + type: string + title: id + description: The shipping address's ID. + customer_id: + type: string + title: customer_id + description: The shipping address's customer id. + company: + type: string + title: company + description: The shipping address's company. + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. province: type: string title: province - description: The address's province. - StorePostCartsCartTaxesReq: - type: object - description: SUMMARY - x-schemaName: StorePostCartsCartTaxesReq - properties: {} - StorePostPaymentCollectionsPaymentSessionReq: - type: object - description: SUMMARY - x-schemaName: StorePostPaymentCollectionsPaymentSessionReq - required: - - provider_id - properties: - provider_id: + description: The shipping address's province. + postal_code: type: string - title: provider_id - description: The payment collection's provider id. - context: {} - data: + title: postal_code + description: The shipping address's postal code. + phone: + type: string + title: phone + description: The shipping address's phone. + metadata: type: object - description: The payment collection's data. - properties: {} + description: The shipping address's metadata. + UpdateCartData: + type: object + description: SUMMARY + x-schemaName: UpdateCartData + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + shipping_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + metadata: + type: object + description: The cart's metadata. + UpdateOrderReturnReason: + type: object + description: SUMMARY + x-schemaName: UpdateOrderReturnReason + properties: + id: + type: string + title: id + description: The return reason's ID. + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index d12892493e..5a5506d3ea 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -12,6 +12,8 @@ tags: - name: Api Keys - name: Campaigns - name: Collections + x-associatedSchema: + $ref: ./components/schemas/AdminCollection.yaml - name: Currencies description: > A store can use unlimited currencies, and each region must be associated @@ -24,15 +26,8 @@ tags: url: >- https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies - name: Customer Groups - description: > - Customer Groups can be used to organize customers that share similar data - or attributes into dedicated groups. - - This can be useful for different purposes such as setting a different - price for a specific customer group. - externalDocs: - description: How to manage customer groups - url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups + x-associatedSchema: + $ref: ./components/schemas/AdminCustomerGroup.yaml - name: Customers description: > Customers can either be created when they register through the Store APIs, @@ -40,16 +35,17 @@ tags: externalDocs: description: How to manage customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers - - name: Fulfillment + x-associatedSchema: + $ref: ./components/schemas/AdminCustomer.yaml + - name: Draft Orders + - name: Fulfillment Providers + x-associatedSchema: + $ref: ./components/schemas/AdminFulfillmentProvider.yaml + - name: Fulfillment Sets + x-associatedSchema: + $ref: ./components/schemas/AdminFulfillmentSet.yaml + - name: Fulfillments - name: Inventory Items - description: > - Inventory items, provided by the [Inventory - Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), - can be used to manage the inventory of saleable items in your store. - externalDocs: - description: How to manage inventory items - url: >- - https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items - name: Invites description: > An admin can invite new users to manage their team. This would allow new @@ -57,26 +53,17 @@ tags: externalDocs: description: How to manage invites url: https://docs.medusajs.com/modules/users/admin/manage-invites + - name: Orders - name: Payments - description: > - A payment can be related to an order, swap, return, or more. It can be - captured or refunded. - name: Price Lists - description: > - A price list are special prices applied to products based on a set of - conditions, such as customer group. - externalDocs: - description: How to manage price lists - url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists - - name: Pricing + - name: Product Categories + x-associatedSchema: + $ref: ./components/schemas/AdminProductCategory.yaml + - name: Product Tags + - name: Product Types - name: Products - description: > - Products are saleable items in a store. This also includes [saleable gift - cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) - in a store. - externalDocs: - description: How to manage products - url: https://docs.medusajs.com/modules/products/admin/manage-products + x-associatedSchema: + $ref: ./components/schemas/AdminProduct.yaml - name: Promotions - name: Regions description: > @@ -88,6 +75,9 @@ tags: description: How to manage regions url: >- https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions + - name: Reservations + - name: Return Reasons + - name: Returns - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -97,24 +87,20 @@ tags: externalDocs: description: How to manage sales channels url: https://docs.medusajs.com/modules/sales-channels/admin/manage + x-associatedSchema: + $ref: ./components/schemas/AdminSalesChannel.yaml + - name: Shipping Options + x-associatedSchema: + $ref: ./components/schemas/AdminShippingOption.yaml + - name: Shipping Profiles + x-associatedSchema: + $ref: ./components/schemas/AdminShippingProfile.yaml - name: Stock Locations - name: Stores - name: Tax Rates - description: > - Each region has at least a default tax rate. Admins can create and manage - additional tax rates that can be applied for certain conditions, such as - for specific product types. - externalDocs: - description: How to manage tax rates - url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates - name: Tax Regions + - name: Uploads - name: Users - description: > - A store can have more than one user, each having the same privileges. - Admins can manage users, their passwords, and more. - externalDocs: - description: How to manage users - url: https://docs.medusajs.com/modules/users/admin/manage-users - name: Workflows Executions paths: /admin/api-keys: @@ -123,14 +109,20 @@ paths: $ref: paths/admin_api-keys_{id}.yaml /admin/api-keys/{id}/revoke: $ref: paths/admin_api-keys_{id}_revoke.yaml + /admin/api-keys/{id}/sales-channels: + $ref: paths/admin_api-keys_{id}_sales-channels.yaml /admin/campaigns: $ref: paths/admin_campaigns.yaml /admin/campaigns/{id}: $ref: paths/admin_campaigns_{id}.yaml + /admin/campaigns/{id}/promotions: + $ref: paths/admin_campaigns_{id}_promotions.yaml /admin/collections: $ref: paths/admin_collections.yaml /admin/collections/{id}: $ref: paths/admin_collections_{id}.yaml + /admin/collections/{id}/products: + $ref: paths/admin_collections_{id}_products.yaml /admin/currencies: $ref: paths/admin_currencies.yaml /admin/currencies/{code}: @@ -141,10 +133,6 @@ paths: $ref: paths/admin_customer-groups_{id}.yaml /admin/customer-groups/{id}/customers: $ref: paths/admin_customer-groups_{id}_customers.yaml - /admin/customer-groups/{id}/customers/batch: - $ref: paths/admin_customer-groups_{id}_customers_batch.yaml - /admin/customer-groups/{id}/customers/remove: - $ref: paths/admin_customer-groups_{id}_customers_remove.yaml /admin/customers: $ref: paths/admin_customers.yaml /admin/customers/{id}: @@ -153,16 +141,32 @@ paths: $ref: paths/admin_customers_{id}_addresses.yaml /admin/customers/{id}/addresses/{address_id}: $ref: paths/admin_customers_{id}_addresses_{address_id}.yaml - /admin/fulfillment/shipping-options/{id}/rules/batch/add: - $ref: paths/admin_fulfillment_shipping-options_{id}_rules_batch_add.yaml - /admin/fulfillment/shipping-options/{id}/rules/batch/remove: - $ref: paths/admin_fulfillment_shipping-options_{id}_rules_batch_remove.yaml + /admin/draft-orders: + $ref: paths/admin_draft-orders.yaml + /admin/draft-orders/{id}: + $ref: paths/admin_draft-orders_{id}.yaml + /admin/fulfillment-providers: + $ref: paths/admin_fulfillment-providers.yaml + /admin/fulfillment-sets/{id}: + $ref: paths/admin_fulfillment-sets_{id}.yaml + /admin/fulfillment-sets/{id}/service-zones: + $ref: paths/admin_fulfillment-sets_{id}_service-zones.yaml + /admin/fulfillment-sets/{id}/service-zones/{zone_id}: + $ref: paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml + /admin/fulfillments: + $ref: paths/admin_fulfillments.yaml + /admin/fulfillments/{id}/cancel: + $ref: paths/admin_fulfillments_{id}_cancel.yaml + /admin/fulfillments/{id}/shipment: + $ref: paths/admin_fulfillments_{id}_shipment.yaml /admin/inventory-items: $ref: paths/admin_inventory-items.yaml /admin/inventory-items/{id}: $ref: paths/admin_inventory-items_{id}.yaml /admin/inventory-items/{id}/location-levels: $ref: paths/admin_inventory-items_{id}_location-levels.yaml + /admin/inventory-items/{id}/location-levels/batch: + $ref: paths/admin_inventory-items_{id}_location-levels_batch.yaml /admin/inventory-items/{id}/location-levels/{location_id}: $ref: paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml /admin/invites: @@ -173,8 +177,26 @@ paths: $ref: paths/admin_invites_{id}.yaml /admin/invites/{id}/resend: $ref: paths/admin_invites_{id}_resend.yaml + /admin/orders: + $ref: paths/admin_orders.yaml + /admin/orders/{id}: + $ref: paths/admin_orders_{id}.yaml + /admin/orders/{id}/archive: + $ref: paths/admin_orders_{id}_archive.yaml + /admin/orders/{id}/cancel: + $ref: paths/admin_orders_{id}_cancel.yaml + /admin/orders/{id}/complete: + $ref: paths/admin_orders_{id}_complete.yaml + /admin/orders/{id}/fulfillments: + $ref: paths/admin_orders_{id}_fulfillments.yaml + /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: + $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml + /admin/orders/{id}/fulfillments/{fulfillment_id}/shipment: + $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml /admin/payments: $ref: paths/admin_payments.yaml + /admin/payments/payment-providers: + $ref: paths/admin_payments_payment-providers.yaml /admin/payments/{id}: $ref: paths/admin_payments_{id}.yaml /admin/payments/{id}/capture: @@ -185,16 +207,28 @@ paths: $ref: paths/admin_price-lists.yaml /admin/price-lists/{id}: $ref: paths/admin_price-lists_{id}.yaml - /admin/price-lists/{id}/prices/batch/add: - $ref: paths/admin_price-lists_{id}_prices_batch_add.yaml - /admin/price-lists/{id}/prices/batch/remove: - $ref: paths/admin_price-lists_{id}_prices_batch_remove.yaml - /admin/pricing/rule-types: - $ref: paths/admin_pricing_rule-types.yaml - /admin/pricing/rule-types/{id}: - $ref: paths/admin_pricing_rule-types_{id}.yaml + /admin/price-lists/{id}/prices/batch: + $ref: paths/admin_price-lists_{id}_prices_batch.yaml + /admin/price-lists/{id}/products: + $ref: paths/admin_price-lists_{id}_products.yaml + /admin/product-categories: + $ref: paths/admin_product-categories.yaml + /admin/product-categories/{id}: + $ref: paths/admin_product-categories_{id}.yaml + /admin/product-categories/{id}/products: + $ref: paths/admin_product-categories_{id}_products.yaml + /admin/product-tags: + $ref: paths/admin_product-tags.yaml + /admin/product-tags/{id}: + $ref: paths/admin_product-tags_{id}.yaml + /admin/product-types: + $ref: paths/admin_product-types.yaml + /admin/product-types/{id}: + $ref: paths/admin_product-types_{id}.yaml /admin/products: $ref: paths/admin_products.yaml + /admin/products/batch: + $ref: paths/admin_products_batch.yaml /admin/products/{id}: $ref: paths/admin_products_{id}.yaml /admin/products/{id}/options: @@ -203,40 +237,78 @@ paths: $ref: paths/admin_products_{id}_options_{option_id}.yaml /admin/products/{id}/variants: $ref: paths/admin_products_{id}_variants.yaml + /admin/products/{id}/variants/batch: + $ref: paths/admin_products_{id}_variants_batch.yaml + /admin/products/{id}/variants/inventory-items/batch: + $ref: paths/admin_products_{id}_variants_inventory-items_batch.yaml /admin/products/{id}/variants/{variant_id}: $ref: paths/admin_products_{id}_variants_{variant_id}.yaml + /admin/products/{id}/variants/{variant_id}/inventory-items: + $ref: paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml + /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: + $ref: >- + paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml /admin/promotions: $ref: paths/admin_promotions.yaml + /admin/promotions/rule-attribute-options/{rule_type}: + $ref: paths/admin_promotions_rule-attribute-options_{rule_type}.yaml + /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}: + $ref: >- + paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml /admin/promotions/{id}: $ref: paths/admin_promotions_{id}.yaml - /admin/promotions/{id}/buy-rules/batch/add: - $ref: paths/admin_promotions_{id}_buy-rules_batch_add.yaml - /admin/promotions/{id}/buy-rules/batch/remove: - $ref: paths/admin_promotions_{id}_buy-rules_batch_remove.yaml - /admin/promotions/{id}/rules/batch/add: - $ref: paths/admin_promotions_{id}_rules_batch_add.yaml - /admin/promotions/{id}/rules/batch/remove: - $ref: paths/admin_promotions_{id}_rules_batch_remove.yaml - /admin/promotions/{id}/rules/batch/update: - $ref: paths/admin_promotions_{id}_rules_batch_update.yaml - /admin/promotions/{id}/target-rules/batch/add: - $ref: paths/admin_promotions_{id}_target-rules_batch_add.yaml - /admin/promotions/{id}/target-rules/batch/remove: - $ref: paths/admin_promotions_{id}_target-rules_batch_remove.yaml + /admin/promotions/{id}/buy-rules/batch: + $ref: paths/admin_promotions_{id}_buy-rules_batch.yaml + /admin/promotions/{id}/rules/batch: + $ref: paths/admin_promotions_{id}_rules_batch.yaml + /admin/promotions/{id}/target-rules/batch: + $ref: paths/admin_promotions_{id}_target-rules_batch.yaml + /admin/promotions/{id}/{rule_type}: + $ref: paths/admin_promotions_{id}_{rule_type}.yaml /admin/regions: $ref: paths/admin_regions.yaml /admin/regions/{id}: $ref: paths/admin_regions_{id}.yaml + /admin/reservations: + $ref: paths/admin_reservations.yaml + /admin/reservations/{id}: + $ref: paths/admin_reservations_{id}.yaml + /admin/return-reasons: + $ref: paths/admin_return-reasons.yaml + /admin/return-reasons/{id}: + $ref: paths/admin_return-reasons_{id}.yaml + /admin/returns: + $ref: paths/admin_returns.yaml + /admin/returns/{id}: + $ref: paths/admin_returns_{id}.yaml + /admin/returns/{id}/cancel: + $ref: paths/admin_returns_{id}_cancel.yaml + /admin/returns/{id}/receive: + $ref: paths/admin_returns_{id}_receive.yaml /admin/sales-channels: $ref: paths/admin_sales-channels.yaml /admin/sales-channels/{id}: $ref: paths/admin_sales-channels_{id}.yaml - /admin/sales-channels/{id}/products/batch/add: - $ref: paths/admin_sales-channels_{id}_products_batch_add.yaml + /admin/sales-channels/{id}/products: + $ref: paths/admin_sales-channels_{id}_products.yaml + /admin/shipping-options: + $ref: paths/admin_shipping-options.yaml + /admin/shipping-options/{id}: + $ref: paths/admin_shipping-options_{id}.yaml + /admin/shipping-options/{id}/rules/batch: + $ref: paths/admin_shipping-options_{id}_rules_batch.yaml + /admin/shipping-profiles: + $ref: paths/admin_shipping-profiles.yaml + /admin/shipping-profiles/{id}: + $ref: paths/admin_shipping-profiles_{id}.yaml /admin/stock-locations: $ref: paths/admin_stock-locations.yaml /admin/stock-locations/{id}: $ref: paths/admin_stock-locations_{id}.yaml + /admin/stock-locations/{id}/fulfillment-sets: + $ref: paths/admin_stock-locations_{id}_fulfillment-sets.yaml + /admin/stock-locations/{id}/sales-channels: + $ref: paths/admin_stock-locations_{id}_sales-channels.yaml /admin/stores: $ref: paths/admin_stores.yaml /admin/stores/{id}: @@ -253,6 +325,10 @@ paths: $ref: paths/admin_tax-regions.yaml /admin/tax-regions/{id}: $ref: paths/admin_tax-regions_{id}.yaml + /admin/uploads: + $ref: paths/admin_uploads.yaml + /admin/uploads/{id}: + $ref: paths/admin_uploads_{id}.yaml /admin/users: $ref: paths/admin_users.yaml /admin/users/me: diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml index 756a231f2f..e868fc76d3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys.yaml @@ -5,7 +5,60 @@ get: 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: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +85,74 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostApiKeys summary: Create Api Key description: Create a api key. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateApiKey.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +161,8 @@ post: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +175,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml index b04d568601..d6ccdcf9bb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostApiKeysId summary: Update a Api Key @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateApiKey.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +187,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteApiKeysId summary: Delete a Api Key @@ -92,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +264,8 @@ delete: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml index 386616429f..3a4a65032f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_revoke.yaml @@ -10,10 +10,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminRevokeApiKey.yaml x-codeSamples: - lang: Shell label: cURL @@ -22,6 +80,8 @@ post: tags: - Api Keys responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -34,7 +94,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml new file mode 100644 index 0000000000..ebb0cbc833 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}_sales-channels.yaml @@ -0,0 +1,112 @@ +post: + operationId: PostApiKeysIdSalesChannels + summary: Add Sales Channels to Api Key + description: Add a list of sales channels to a api key. + x-authenticated: true + parameters: + - name: id + in: path + description: The api key's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The api key's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The api key's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_api-keys_{id}_sales-channels/post.sh + tags: + - Api Keys + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml index 3e908eca60..48a4085515 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Campaigns responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +85,137 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCampaigns summary: Create Campaign description: Create a campaign. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. x-codeSamples: - lang: Shell label: cURL @@ -52,6 +224,8 @@ post: tags: - Campaigns responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +238,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml index cbe4e2e900..25863ad737 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Campaigns responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCampaignsId summary: Update a Campaign @@ -52,6 +103,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -60,7 +164,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostCampaignsReq.yaml + $ref: ../components/schemas/AdminUpdateCampaign.yaml x-codeSamples: - lang: Shell label: cURL @@ -69,6 +173,8 @@ post: tags: - Campaigns responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -93,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -105,6 +264,8 @@ delete: tags: - Campaigns responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -117,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml new file mode 100644 index 0000000000..d28ad391a6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}_promotions.yaml @@ -0,0 +1,112 @@ +post: + operationId: PostCampaignsIdPromotions + summary: Add Promotions to Campaign + description: Add a list of promotions to a campaign. + x-authenticated: true + parameters: + - name: id + in: path + description: The campaign's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The campaign's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The campaign's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_campaigns_{id}_promotions/post.sh + tags: + - Campaigns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml index 61db631ea0..ea4372ff56 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +85,74 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCollections summary: Create Collection description: Create a collection. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateCollection.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +161,8 @@ post: tags: - Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +175,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index 4db0e2a3f1..3bd05e1f3f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCollectionsId summary: Update a Collection @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateCollection.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +187,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCollectionsId summary: Delete a Collection @@ -92,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +264,8 @@ delete: tags: - Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml new file mode 100644 index 0000000000..289b762f9b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}_products.yaml @@ -0,0 +1,112 @@ +post: + operationId: PostCollectionsIdProducts + summary: Add Products to Collection + description: Add a list of products to a collection. + x-authenticated: true + parameters: + - name: id + in: path + description: The collection's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The collection's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The collection's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_collections_{id}_products/post.sh + tags: + - Collections + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml index 586c02fc3e..bb909a4844 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Currencies responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,7 +85,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml index 8570532991..8a5921ab57 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Currencies responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,7 +91,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml index fab8099d36..87c0661cda 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +85,74 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomerGroups summary: Create Customer Group description: Create a customer group. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateCustomerGroup.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +161,8 @@ post: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +175,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index e1b6789dfd..942b510e38 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomerGroupsId summary: Update a Customer Group @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateCustomerGroup.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +187,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomerGroupsId summary: Delete a Customer Group @@ -92,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +264,8 @@ delete: tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml index bfb2f4dd54..248df0d542 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers.yaml @@ -1,9 +1,7 @@ -get: - operationId: GetCustomerGroupsIdCustomers - summary: List Customers - description: >- - Retrieve a list of customers in a customer group. The customers can be - filtered by fields like FILTER FIELDS. The customers can also be paginated. +post: + operationId: PostCustomerGroupsIdCustomers + summary: Add Customers to Customer Group + description: Add a list of customers to a customer group. x-authenticated: true parameters: - name: id @@ -12,18 +10,94 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The customer group's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The customer group's remove. + items: + type: string + title: remove + description: The remove's details. x-codeSamples: - lang: Shell label: cURL source: - $ref: ../code_samples/Shell/admin_customer-groups_{id}_customers/get.sh + $ref: ../code_samples/Shell/admin_customer-groups_{id}_customers/post.sh tags: - Customer Groups responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,7 +110,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml deleted file mode 100644 index 81c5eac2aa..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_batch.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostCustomerGroupsIdCustomersBatch - summary: Add Customers to Customer Group - description: Add a list of customers to a customer group. - x-authenticated: true - parameters: - - name: id - in: path - description: The customer group's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_customer-groups_{id}_customers_batch/post.sh - tags: - - Customer Groups - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_remove.yaml deleted file mode 100644 index 2e5da7f83d..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}_customers_remove.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostCustomerGroupsIdCustomersRemove - summary: Add Removes to Customer Group - description: Add a list of removes to a customer group. - x-authenticated: true - parameters: - - name: id - in: path - description: The customer group's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_customer-groups_{id}_customers_remove/post.sh - tags: - - Customer Groups - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml index 0fabec7b94..9a03acf112 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,38 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The customer's limit. + offset: + type: number + title: offset + description: The customer's offset. + count: + type: number + title: count + description: The customer's count. + - type: object + description: SUMMARY + required: + - customers + properties: + customers: + $ref: ../components/schemas/AdminCustomer.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +115,74 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomers summary: Create Customer description: Create a customer. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateCustomer.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +191,18 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: ../components/schemas/AdminCustomer.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +215,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index 0050fbef8c..f95c8a0f75 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,18 @@ get: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: ../components/schemas/AdminCustomer.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +101,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersId summary: Update a Customer @@ -52,10 +113,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateCustomer.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +183,18 @@ post: tags: - Customers responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - customer + properties: + customer: + $ref: ../components/schemas/AdminCustomer.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +207,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersId summary: Delete a Customer @@ -92,6 +219,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +284,8 @@ delete: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +298,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml index dfd08f1c43..29e99add5d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersIdAddresses summary: Add Addresses to Customer @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateCustomerAddress.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,7 +187,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 39d2af9d49..30f2e7a8da 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -18,6 +18,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -31,6 +84,8 @@ get: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -43,10 +98,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersIdAddressesAddress_id summary: Add Addresses to Customer @@ -65,10 +116,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateCustomerAddress.yaml x-codeSamples: - lang: Shell label: cURL @@ -78,6 +187,8 @@ post: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -90,10 +201,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersIdAddressesAddress_id summary: Remove Addresses from Customer @@ -114,6 +221,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -127,6 +287,8 @@ delete: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -139,7 +301,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml new file mode 100644 index 0000000000..633a1cb87f --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders.yaml @@ -0,0 +1,458 @@ +get: + operationId: GetDraftOrders + summary: List Draft Orders + description: >- + Retrieve a list of draft orders. The draft orders can be filtered by fields + such as `id`. The draft orders can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_draft-orders/get.sh + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostDraftOrders + summary: Create Draft Order + description: Create a draft order. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - sales_channel_id + - email + - customer_id + - region_id + - currency_code + - shipping_methods + - metadata + properties: + status: + type: boolean + title: status + description: The draft order's status. + sales_channel_id: + type: string + title: sales_channel_id + description: The draft order's sales channel id. + email: + type: string + title: email + description: The draft order's email. + format: email + customer_id: + type: string + title: customer_id + description: The draft order's customer id. + billing_address: + type: object + description: The draft order's billing address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + shipping_address: + type: object + description: The draft order's shipping address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + phone: + type: string + title: phone + description: The shipping address's phone. + company: + type: string + title: company + description: The shipping address's company. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + metadata: + type: object + description: The shipping address's metadata. + items: + type: array + description: The draft order's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - barcode + - variant_id + - unit_price + - quantity + - metadata + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + barcode: + type: string + title: barcode + description: The item's barcode. + variant_id: + type: string + title: variant_id + description: The item's variant id. + unit_price: + oneOf: + - type: string + title: unit_price + description: The item's unit price. + - type: number + title: unit_price + description: The item's unit price. + - type: object + description: The item's unit price. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The unit price's value. + precision: + type: number + title: precision + description: The unit price's precision. + quantity: + type: number + title: quantity + description: The item's quantity. + metadata: + type: object + description: The item's metadata. + region_id: + type: string + title: region_id + description: The draft order's region id. + promo_codes: + type: array + description: The draft order's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + currency_code: + type: string + title: currency_code + description: The draft order's currency code. + no_notification_order: + type: boolean + title: no_notification_order + description: The draft order's no notification order. + shipping_methods: + type: array + description: The draft order's shipping methods. + items: + type: object + description: The shipping method's shipping methods. + required: + - shipping_method_id + - order_id + - name + - option_id + - amount + properties: + shipping_method_id: + type: string + title: shipping_method_id + description: The shipping method's shipping method id. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + option_id: + type: string + title: option_id + description: The shipping method's option id. + data: + type: object + description: The shipping method's data. + amount: + oneOf: + - type: string + title: amount + description: The shipping method's amount. + - type: number + title: amount + description: The shipping method's amount. + - type: object + description: The shipping method's amount. + required: + - value + - precision + properties: + value: + type: string + title: value + description: The amount's value. + precision: + type: number + title: precision + description: The amount's precision. + metadata: + type: object + description: The draft order's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_draft-orders/post.sh + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml new file mode 100644 index 0000000000..86bed57f84 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_draft-orders_{id}.yaml @@ -0,0 +1,93 @@ +get: + operationId: GetDraftOrdersId + summary: Get a Draft Order + description: >- + Retrieve a draft order by its ID. You can expand the draft order's relations + or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The draft order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_draft-orders_{id}/get.sh + tags: + - Draft Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml new file mode 100644 index 0000000000..fef8fe9538 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-providers.yaml @@ -0,0 +1,118 @@ +get: + operationId: GetFulfillmentProviders + summary: List Fulfillment Providers + description: >- + Retrieve a list of fulfillment providers. The fulfillment providers can be + filtered by fields such as `id`. The fulfillment providers can also be + sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The fulfillment provider's ID. + - type: array + description: The fulfillment provider's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The fulfillment provider's is enabled. + required: true + schema: + type: boolean + title: is_enabled + description: The fulfillment provider's is enabled. + - name: q + in: query + description: The fulfillment provider's q. + required: false + schema: + type: string + title: q + description: The fulfillment provider's q. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillment-providers/get.sh + tags: + - Fulfillment Providers + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml new file mode 100644 index 0000000000..563ae6437e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}.yaml @@ -0,0 +1,95 @@ +delete: + operationId: DeleteFulfillmentSetsId + summary: Delete a Fulfillment Set + description: Delete a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillment-sets_{id}/delete.sh + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentSetDeleteResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml new file mode 100644 index 0000000000..45f174cbf7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones.yaml @@ -0,0 +1,211 @@ +post: + operationId: PostFulfillmentSetsIdServiceZones + summary: Add Service Zones to Fulfillment Set + description: Add a list of service zones to a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The fulfillment set's name. + geo_zones: + type: array + description: The fulfillment set's geo zones. + items: + oneOf: + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + - city + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + city: + type: string + title: city + description: The geo zone's city. + - type: object + description: The geo zone's geo zones. + required: + - metadata + - country_code + - type + - province_code + - city + - postal_expression + properties: + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + type: + type: string + title: type + description: The geo zone's type. + province_code: + type: string + title: province_code + description: The geo zone's province code. + city: + type: string + title: city + description: The geo zone's city. + postal_expression: + type: object + description: The geo zone's postal expression. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_fulfillment-sets_{id}_service-zones/post.sh + tags: + - Fulfillment Sets + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml new file mode 100644 index 0000000000..7632b5ae43 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -0,0 +1,443 @@ +get: + operationId: GetFulfillmentSetsIdServiceZonesZone_id + summary: List Service Zones + description: >- + Retrieve a list of service zones in a fulfillment set. The service zones can + be filtered by fields like FILTER FIELDS. The service zones can also be + paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/get.sh + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminServiceZoneResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostFulfillmentSetsIdServiceZonesZone_id + summary: Add Service Zones to Fulfillment Set + description: Add a list of service zones to a fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + properties: + name: + type: string + title: name + description: The fulfillment set's name. + geo_zones: + type: array + description: The fulfillment set's geo zones. + items: + oneOf: + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - country_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - country_code + - province_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - city + - country_code + - province_code + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + city: + type: string + title: city + description: The geo zone's city. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + id: + type: string + title: id + description: The geo zone's ID. + - type: object + description: The geo zone's geo zones. + required: + - type + - metadata + - city + - country_code + - province_code + - postal_expression + properties: + type: + type: string + title: type + description: The geo zone's type. + metadata: + type: object + description: The geo zone's metadata. + city: + type: string + title: city + description: The geo zone's city. + country_code: + type: string + title: country_code + description: The geo zone's country code. + province_code: + type: string + title: province_code + description: The geo zone's province code. + postal_expression: + type: object + description: The geo zone's postal expression. + id: + type: string + title: id + description: The geo zone's ID. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/post.sh + tags: + - Fulfillment Sets + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminFulfillmentSetResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteFulfillmentSetsIdServiceZonesZone_id + summary: Remove Service Zones from Fulfillment Set + description: >- + Remove a list of service zones from a fulfillment set. This doesn't delete + the Service Zone, only the association between the Service Zone and the + fulfillment set. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment set's ID. + required: true + schema: + type: string + - name: zone_id + in: path + description: The fulfillment set's zone id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_fulfillment-sets_{id}_service-zones_{zone_id}/delete.sh + tags: + - Fulfillment Sets + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_add.yaml deleted file mode 100644 index 7c9abbb298..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_add.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostFulfillmentShippingOptionsIdRulesBatchAdd - summary: Add Adds to Fulfillment - description: Add a list of adds to a fulfillment. - x-authenticated: true - parameters: - - name: id - in: path - description: The fulfillment's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_add/post.sh - tags: - - Fulfillment - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_remove.yaml deleted file mode 100644 index 50ff321b26..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment_shipping-options_{id}_rules_batch_remove.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostFulfillmentShippingOptionsIdRulesBatchRemove - summary: Add Removes to Fulfillment - description: Add a list of removes to a fulfillment. - x-authenticated: true - parameters: - - name: id - in: path - description: The fulfillment's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_fulfillment_shipping-options_{id}_rules_batch_remove/post.sh - tags: - - Fulfillment - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml new file mode 100644 index 0000000000..58086ffb59 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -0,0 +1,90 @@ +post: + operationId: PostFulfillments + summary: Create Fulfillment + description: Create a fulfillment. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateFulfillment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillments/post.sh + tags: + - Fulfillments + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml new file mode 100644 index 0000000000..0f28fe90bb --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_cancel.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostFulfillmentsIdCancel + summary: Add Cancels to Fulfillment + description: Add a list of cancels to a fulfillment. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCancelFulfillment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillments_{id}_cancel/post.sh + tags: + - Fulfillments + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml new file mode 100644 index 0000000000..515faaf667 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments_{id}_shipment.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostFulfillmentsIdShipment + summary: Add Shipments to Fulfillment + description: Add a list of shipments to a fulfillment. + x-authenticated: true + parameters: + - name: id + in: path + description: The fulfillment's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateShipment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_fulfillments_{id}_shipment/post.sh + tags: + - Fulfillments + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml index e2b35b2d37..edc3a5d649 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items.yaml @@ -5,7 +5,319 @@ get: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The inventory item's q. + required: false + schema: + type: string + title: q + description: The inventory item's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The inventory item's ID. + - type: array + description: The inventory item's ID. + items: + type: string + title: id + description: The id's ID. + - name: sku + in: query + required: false + schema: + oneOf: + - type: string + title: sku + description: The inventory item's sku. + - type: array + description: The inventory item's sku. + items: + type: string + title: sku + description: The sku's details. + - name: origin_country + in: query + required: false + schema: + oneOf: + - type: string + title: origin_country + description: The inventory item's origin country. + - type: array + description: The inventory item's origin country. + items: + type: string + title: origin_country + description: The origin country's details. + - name: mid_code + in: query + required: false + schema: + oneOf: + - type: string + title: mid_code + description: The inventory item's mid code. + - type: array + description: The inventory item's mid code. + items: + type: string + title: mid_code + description: The mid code's details. + - name: hs_code + in: query + required: false + schema: + oneOf: + - type: string + title: hs_code + description: The inventory item's hs code. + - type: array + description: The inventory item's hs code. + items: + type: string + title: hs_code + description: The hs code's details. + - name: material + in: query + required: false + schema: + oneOf: + - type: string + title: material + description: The inventory item's material. + - type: array + description: The inventory item's material. + items: + type: string + title: material + description: The material's details. + - name: requires_shipping + in: query + description: The inventory item's requires shipping. + required: true + schema: + type: boolean + title: requires_shipping + description: The inventory item's requires shipping. + - name: weight + in: query + description: The inventory item's weight. + required: false + schema: + type: object + description: The inventory item's weight. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: length + in: query + description: The inventory item's length. + required: false + schema: + type: object + description: The inventory item's length. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: height + in: query + description: The inventory item's height. + required: false + schema: + type: object + description: The inventory item's height. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: width + in: query + description: The inventory item's width. + required: false + schema: + type: object + description: The inventory item's width. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: location_levels + in: query + description: The inventory item's location levels. + required: false + schema: + type: object + description: The inventory item's location levels. + properties: + location_id: + oneOf: + - type: string + title: location_id + description: The location level's location id. + - type: array + description: The location level's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +330,8 @@ get: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,16 +344,65 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostInventoryItems summary: Create Inventory Item description: Create a inventory item. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -48,7 +411,99 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostInventoryItemsReq.yaml + 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. x-codeSamples: - lang: Shell label: cURL @@ -57,6 +512,8 @@ post: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml index 7074f3a305..2c87b83467 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostInventoryItemsId summary: Update a Inventory Item @@ -52,6 +103,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -60,7 +164,78 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml + 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. x-codeSamples: - lang: Shell label: cURL @@ -95,6 +270,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -107,6 +335,8 @@ delete: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -119,7 +349,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml index a7cd8053b4..7f5a7adc97 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels.yaml @@ -1,7 +1,10 @@ -post: - operationId: PostInventoryItemsIdLocationLevels - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. +get: + operationId: GetInventoryItemsIdLocationLevels + summary: List Location Levels + description: >- + Retrieve a list of location levels in a inventory item. The location levels + can be filtered by fields like FILTER FIELDS. The location levels can also + be paginated. x-authenticated: true parameters: - name: id @@ -10,25 +13,209 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The inventory item's location id. + - type: array + description: The inventory item's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml x-codeSamples: - lang: Shell label: cURL source: $ref: >- - ../code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh + ../code_samples/Shell/admin_inventory-items_{id}_location-levels/get.sh tags: - Inventory Items responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostInventoryItemsIdLocationLevels + summary: Add Location Levels to Inventory Item + description: Add a list of location levels to a inventory item. + x-authenticated: true + parameters: + - name: id + in: path + description: The inventory item's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The inventory item's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory item's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory item's incoming quantity. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_inventory-items_{id}_location-levels/post.sh + tags: + - Inventory Items + responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml new file mode 100644 index 0000000000..5c34e03bab --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml @@ -0,0 +1,142 @@ +post: + operationId: PostInventoryItemsIdLocationLevelsBatch + summary: Add Location Levels to Inventory Item + description: Add a list of location levels to a inventory item. + x-authenticated: true + parameters: + - name: id + in: path + description: The inventory item's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The inventory item's create. + items: + type: object + description: The create's details. + required: + - location_id + properties: + location_id: + type: string + title: location_id + description: The create's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The create's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The create's incoming quantity. + update: + type: array + description: The inventory item's update. + items: + type: object + description: The update's details. + properties: + stocked_quantity: + type: number + title: stocked_quantity + description: The update's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The update's incoming quantity. + delete: + type: array + description: The inventory item's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_inventory-items_{id}_location-levels_batch/post.sh + tags: + - Inventory Items + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml index bf33698fef..02c8b58aa3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_{location_id}.yaml @@ -16,6 +16,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,8 +77,17 @@ post: content: application/json: schema: - $ref: >- - ../components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml + type: object + description: SUMMARY + properties: + stocked_quantity: + type: number + title: stocked_quantity + description: The inventory item's stocked quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The inventory item's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -70,6 +132,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -83,6 +198,8 @@ delete: tags: - Inventory Items responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -95,7 +212,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml index c7fadba0ac..7abc6c5325 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -4,12 +4,206 @@ get: description: >- Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The invite's q. + required: false + schema: + type: string + title: q + description: The invite's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The invite's ID. + - type: array + description: The invite's ID. + items: + type: string + title: id + description: The id's ID. + - name: email + in: query + required: false + schema: + oneOf: + - type: string + title: email + description: The invite's email. + format: email + - type: array + description: The invite's email. + items: + type: string + title: email + description: The email's details. + format: email + - name: created_at + in: query + description: The invite's created at. + required: false + schema: + type: object + description: The invite's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The invite's updated at. + required: false + schema: + type: object + description: The invite's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The invite's deleted at. + required: false + schema: + type: object + description: The invite's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} x-codeSamples: - lang: Shell label: cURL @@ -18,6 +212,8 @@ get: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +226,79 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostInvites summary: Create Invite description: Create a invite. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - email + properties: + email: + type: string + title: email + description: The invite's email. + format: email x-codeSamples: - lang: Shell label: cURL @@ -52,6 +307,8 @@ post: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +321,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index 48794e3dd7..9dd2b60cdf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -2,17 +2,85 @@ post: operationId: PostInvitesAccept summary: Create Invite description: Create a invite. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. requestBody: content: application/json: schema: - $ref: ../components/schemas/AdminPostInvitesInviteAcceptReq.yaml + type: object + description: SUMMARY + required: + - email + - first_name + - last_name + properties: + email: + type: string + title: email + description: The invite's email. + format: email + first_name: + type: string + title: first_name + description: The invite's first name. + last_name: + type: string + title: last_name + description: The invite's last name. x-codeSamples: - lang: Shell label: cURL @@ -21,6 +89,8 @@ post: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index 89510cd0b2..98ccba6fc9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a invite by its ID. You can expand the invite's relations or select the fields that should be returned. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -12,10 +12,59 @@ get: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -24,6 +73,8 @@ get: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,15 +87,11 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteInvitesId summary: Delete a Invite description: Delete a invite. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -52,10 +99,59 @@ delete: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -64,6 +160,8 @@ delete: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,7 +174,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml index 49f4af935a..aa03ee198d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}_resend.yaml @@ -2,7 +2,7 @@ post: operationId: PostInvitesIdResend summary: Add Resends to Invite description: Add a list of resends to a invite. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -10,10 +10,59 @@ post: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -22,6 +71,8 @@ post: tags: - Invites responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -34,7 +85,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml new file mode 100644 index 0000000000..ff699e9cd4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -0,0 +1,87 @@ +get: + operationId: GetOrders + summary: List Orders + description: >- + Retrieve a list of orders. The orders can be filtered by fields such as + `id`. The orders can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders/get.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml new file mode 100644 index 0000000000..dc2d814a68 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -0,0 +1,184 @@ +get: + operationId: GetOrdersId + summary: Get a Order + description: >- + Retrieve a order by its ID. You can expand the order's relations or select + the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}/get.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostOrdersId + summary: Update a Order + description: Update a order's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml new file mode 100644 index 0000000000..bb368468fd --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_archive.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostOrdersIdArchive + summary: Add Archives to Order + description: Add a list of archives to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminArchiveOrder.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_archive/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml new file mode 100644 index 0000000000..19fb3c4f2b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_cancel.yaml @@ -0,0 +1,91 @@ +post: + operationId: PostOrdersIdCancel + summary: Add Cancels to Order + description: Add a list of cancels to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_cancel/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml new file mode 100644 index 0000000000..7b441aecc4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_complete.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostOrdersIdComplete + summary: Add Completes to Order + description: Add a list of completes to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCompleteOrder.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_complete/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml new file mode 100644 index 0000000000..cb0ba128ba --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostOrdersIdFulfillments + summary: Add Fulfillments to Order + description: Add a list of fulfillments to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderCreateFulfillment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_fulfillments/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml new file mode 100644 index 0000000000..64e470c1a4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml @@ -0,0 +1,103 @@ +post: + operationId: PostOrdersIdFulfillmentsFulfillment_idCancel + summary: Add Cancels to Order + description: Add a list of cancels to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The order's fulfillment id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderCancelFulfillment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml new file mode 100644 index 0000000000..584da6fde8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment.yaml @@ -0,0 +1,103 @@ +post: + operationId: PostOrdersIdFulfillmentsFulfillment_idShipment + summary: Add Shipments to Order + description: Add a list of shipments to a order. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The order's fulfillment id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderCreateShipment.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_shipment/post.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml index c12369c9c3..8c955b9bbc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -5,7 +5,203 @@ get: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The payment's q. + required: false + schema: + type: string + title: q + description: The payment's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment's ID. + - type: array + description: The payment's ID. + items: + type: string + title: id + description: The id's ID. + - name: payment_session_id + in: query + required: false + schema: + oneOf: + - type: string + title: payment_session_id + description: The payment's payment session id. + - type: array + description: The payment's payment session id. + items: + type: string + title: payment_session_id + description: The payment session id's details. + - name: created_at + in: query + description: The payment's created at. + required: false + schema: + type: object + description: The payment's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The payment's updated at. + required: false + schema: + type: object + description: The payment's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The payment's deleted at. + required: false + schema: + type: object + description: The payment's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +214,8 @@ get: tags: - Payments responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,7 +228,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml new file mode 100644 index 0000000000..47bfe5a1c5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_payment-providers.yaml @@ -0,0 +1,117 @@ +get: + operationId: GetPaymentsPaymentProviders + summary: List Payments + description: >- + Retrieve a list of payments. The payments can be filtered by fields such as + `id`. The payments can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment's ID. + - type: array + description: The payment's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The payment's is enabled. + required: false + schema: + type: boolean + title: is_enabled + description: The payment's is enabled. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_payments_payment-providers/get.sh + tags: + - Payments + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml index 3645a7b963..cecdcfb671 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Payments responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,7 +91,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml index 351b9a32fc..fc6d8b82a8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_capture.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,13 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostPaymentsCapturesReq.yaml + type: object + description: SUMMARY + properties: + amount: + type: number + title: amount + description: The payment's amount. x-codeSamples: - lang: Shell label: cURL @@ -27,6 +86,8 @@ post: tags: - Payments responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml index 198385879d..43995061c9 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}_refund.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,13 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostPaymentsRefundsReq.yaml + type: object + description: SUMMARY + properties: + amount: + type: number + title: amount + description: The payment's amount. x-codeSamples: - lang: Shell label: cURL @@ -27,6 +86,8 @@ post: tags: - Payments responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml index 71af97f809..93ac0f84c3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,6 +71,8 @@ get: tags: - Price Lists responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,16 +85,65 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostPriceLists summary: Create Price List description: Create a price list. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -48,7 +152,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostPriceListsReq.yaml + $ref: ../components/schemas/AdminCreatePriceList.yaml x-codeSamples: - lang: Shell label: cURL @@ -57,6 +161,8 @@ post: tags: - Price Lists responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml index ba9185e216..e0428e06cf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Price Lists responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostPriceListsId summary: Update a Price List @@ -52,6 +103,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -60,7 +164,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostPriceListsPriceListReq.yaml + $ref: ../components/schemas/AdminUpdatePriceList.yaml x-codeSamples: - lang: Shell label: cURL @@ -69,6 +173,8 @@ post: tags: - Price Lists responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -93,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -105,6 +264,8 @@ delete: tags: - Price Lists responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -117,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml new file mode 100644 index 0000000000..79c9d8410e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -0,0 +1,180 @@ +post: + operationId: PostPriceListsIdPricesBatch + summary: Add Prices to Price List + description: Add a list of prices to a price list. + x-authenticated: true + parameters: + - name: id + in: path + description: The price list's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The price list's create. + items: + type: object + description: The create's details. + required: + - currency_code + - amount + - variant_id + - min_quantity + - max_quantity + properties: + currency_code: + type: string + title: currency_code + description: The create's currency code. + amount: + type: number + title: amount + description: The create's amount. + variant_id: + type: string + title: variant_id + description: The create's variant id. + min_quantity: + type: number + title: min_quantity + description: The create's min quantity. + max_quantity: + type: number + title: max_quantity + description: The create's max quantity. + rules: + type: object + description: The create's rules. + update: + type: array + description: The price list's update. + items: + type: object + description: The update's details. + required: + - id + - variant_id + - min_quantity + - max_quantity + properties: + id: + type: string + title: id + description: The update's ID. + currency_code: + type: string + title: currency_code + description: The update's currency code. + amount: + type: number + title: amount + description: The update's amount. + variant_id: + type: string + title: variant_id + description: The update's variant id. + min_quantity: + type: number + title: min_quantity + description: The update's min quantity. + max_quantity: + type: number + title: max_quantity + description: The update's max quantity. + rules: + type: object + description: The update's rules. + delete: + type: array + description: The price list's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_price-lists_{id}_prices_batch/post.sh + tags: + - Price Lists + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_add.yaml deleted file mode 100644 index de94463d4e..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_add.yaml +++ /dev/null @@ -1,42 +0,0 @@ -post: - operationId: PostPriceListsIdPricesBatchAdd - summary: Add Adds to Price List - description: Add a list of adds to a price list. - x-authenticated: true - parameters: - - name: id - in: path - description: The price list's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_price-lists_{id}_prices_batch_add/post.sh - tags: - - Price Lists - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_remove.yaml deleted file mode 100644 index 1d6eacfee7..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch_remove.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostPriceListsIdPricesBatchRemove - summary: Add Removes to Price List - description: Add a list of removes to a price list. - x-authenticated: true - parameters: - - name: id - in: path - description: The price list's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_price-lists_{id}_prices_batch_remove/post.sh - tags: - - Price Lists - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml new file mode 100644 index 0000000000..f8599a4120 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_products.yaml @@ -0,0 +1,112 @@ +post: + operationId: PostPriceListsIdProducts + summary: Add Products to Price List + description: Add a list of products to a price list. + x-authenticated: true + parameters: + - name: id + in: path + description: The price list's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The price list's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The price list's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_price-lists_{id}_products/post.sh + tags: + - Price Lists + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types.yaml deleted file mode 100644 index 7c9ad3be93..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types.yaml +++ /dev/null @@ -1,72 +0,0 @@ -get: - operationId: GetPricingRuleTypes - summary: List Pricing - description: >- - Retrieve a list of pricing. The pricing can be filtered by fields such as - `id`. The pricing can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminGetPricingRuleTypesParams.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_pricing_rule-types/get.sh - tags: - - Pricing - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml -post: - operationId: PostPricingRuleTypes - summary: Create Pricing - description: Create a pricing. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminPostPricingRuleTypesReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_pricing_rule-types/post.sh - tags: - - Pricing - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types_{id}.yaml deleted file mode 100644 index b9ff3f0f84..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_pricing_rule-types_{id}.yaml +++ /dev/null @@ -1,127 +0,0 @@ -get: - operationId: GetPricingRuleTypesId - summary: List Rule Types - description: >- - Retrieve a list of rule types in a pricing. The rule types can be filtered - by fields like FILTER FIELDS. The rule types can also be paginated. - x-authenticated: true - parameters: - - name: id - in: path - description: The pricing's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_pricing_rule-types_{id}/get.sh - tags: - - Pricing - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml -post: - operationId: PostPricingRuleTypesId - summary: Add Rule Types to Pricing - description: Add a list of rule types to a pricing. - x-authenticated: true - parameters: - - name: id - in: path - description: The pricing's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_pricing_rule-types_{id}/post.sh - tags: - - Pricing - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml -delete: - operationId: DeletePricingRuleTypesId - summary: Remove Rule Types from Pricing - description: >- - Remove a list of rule types from a pricing. This doesn't delete the Rule - Type, only the association between the Rule Type and the pricing. - x-authenticated: true - parameters: - - name: id - in: path - description: The pricing's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_pricing_rule-types_{id}/delete.sh - tags: - - Pricing - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml new file mode 100644 index 0000000000..2422fd2721 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml @@ -0,0 +1,426 @@ +get: + operationId: GetProductCategories + summary: List Product Categories + description: >- + Retrieve a list of product categories. The product categories can be + filtered by fields such as `id`. The product categories can also be sorted + or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The product category's q. + required: false + schema: + type: string + title: q + description: The product category's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product category's ID. + - type: array + description: The product category's ID. + items: + type: string + title: id + description: The id's ID. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The product category's description. + - type: array + description: The product category's description. + items: + type: string + title: description + description: The description's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product category's handle. + - type: array + description: The product category's handle. + items: + type: string + title: handle + description: The handle's details. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: The product category's parent category id. + - type: array + description: The product category's parent category id. + items: + type: string + title: parent_category_id + description: The parent category id's details. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + - name: is_internal + in: query + description: The product category's is internal. + required: true + schema: + type: boolean + title: is_internal + description: The product category's is internal. + - name: is_active + in: query + description: The product category's is active. + required: true + schema: + type: boolean + title: is_active + description: The product category's is active. + - name: created_at + in: query + description: The product category's created at. + required: false + schema: + type: object + description: The product category's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product category's updated at. + required: false + schema: + type: object + description: The product category's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product category's deleted at. + required: false + schema: + type: object + description: The product category's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories/get.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryListResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductCategories + summary: Create Product Category + description: Create a product category. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories/post.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml new file mode 100644 index 0000000000..698320d062 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -0,0 +1,340 @@ +get: + operationId: GetProductCategoriesId + summary: Get a Product Category + description: >- + Retrieve a product category by its ID. You can expand the product category's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories_{id}/get.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductCategoriesId + summary: Update a Product Category + description: Update a product category's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories_{id}/post.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteProductCategoriesId + summary: Delete a Product Category + description: Delete a product category. + x-authenticated: true + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories_{id}/delete.sh + tags: + - Product Categories + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml new file mode 100644 index 0000000000..44e79b2e68 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -0,0 +1,116 @@ +post: + operationId: PostProductCategoriesIdProducts + summary: Add Products to Product Category + description: Add a list of products to a product category. + x-authenticated: true + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The product category's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The product category's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-categories_{id}_products/post.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductCategoryResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml new file mode 100644 index 0000000000..206234dac8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml @@ -0,0 +1,332 @@ +get: + operationId: GetProductTags + summary: List Product Tags + description: >- + Retrieve a list of product tags. The product tags can be filtered by fields + such as `id`. The product tags can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The product tag's q. + required: false + schema: + type: string + title: q + description: The product tag's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product tag's ID. + - type: array + description: The product tag's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The product tag's value. + - type: array + description: The product tag's value. + items: + type: string + title: value + description: The value's details. + - name: created_at + in: query + description: The product tag's created at. + required: false + schema: + type: object + description: The product tag's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product tag's updated at. + required: false + schema: + type: object + description: The product tag's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product tag's deleted at. + required: false + schema: + type: object + description: The product tag's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-tags/get.sh + tags: + - Product Tags + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductTags + summary: Create Product Tag + description: Create a product tag. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-tags/post.sh + tags: + - Product Tags + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml new file mode 100644 index 0000000000..caf2054a3a --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml @@ -0,0 +1,291 @@ +get: + operationId: GetProductTagsId + summary: Get a Product Tag + description: >- + Retrieve a product tag by its ID. You can expand the product tag's relations + or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-tags_{id}/get.sh + tags: + - Product Tags + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductTagsId + summary: Update a Product Tag + description: Update a product tag's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + value: + type: string + title: value + description: The product tag's value. + metadata: + type: object + description: The product tag's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-tags_{id}/post.sh + tags: + - Product Tags + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteProductTagsId + summary: Delete a Product Tag + description: Delete a product tag. + x-authenticated: true + parameters: + - name: id + in: path + description: The product tag's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-tags_{id}/delete.sh + tags: + - Product Tags + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml new file mode 100644 index 0000000000..69bec65b4b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml @@ -0,0 +1,332 @@ +get: + operationId: GetProductTypes + summary: List Product Types + description: >- + Retrieve a list of product types. The product types can be filtered by + fields such as `id`. The product types can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The product type's q. + required: false + schema: + type: string + title: q + description: The product type's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product type's ID. + - type: array + description: The product type's ID. + items: + type: string + title: id + description: The id's ID. + - name: value + in: query + required: false + schema: + oneOf: + - type: string + title: value + description: The product type's value. + - type: array + description: The product type's value. + items: + type: string + title: value + description: The value's details. + - name: created_at + in: query + description: The product type's created at. + required: false + schema: + type: object + description: The product type's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product type's updated at. + required: false + schema: + type: object + description: The product type's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product type's deleted at. + required: false + schema: + type: object + description: The product type's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-types/get.sh + tags: + - Product Types + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductTypes + summary: Create Product Type + description: Create a product type. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-types/post.sh + tags: + - Product Types + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml new file mode 100644 index 0000000000..4f730b441f --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml @@ -0,0 +1,291 @@ +get: + operationId: GetProductTypesId + summary: Get a Product Type + description: >- + Retrieve a product type by its ID. You can expand the product type's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-types_{id}/get.sh + tags: + - Product Types + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostProductTypesId + summary: Update a Product Type + description: Update a product type's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + value: + type: string + title: value + description: The product type's value. + metadata: + type: object + description: The product type's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-types_{id}/post.sh + tags: + - Product Types + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteProductTypesId + summary: Delete a Product Type + description: Delete a product type. + x-authenticated: true + parameters: + - name: id + in: path + description: The product type's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_product-types_{id}/delete.sh + tags: + - Product Types + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_products.yaml index ab6ac1e81f..8af2541b4f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -5,16 +5,13980 @@ get: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: price_list_id + in: query + required: false + schema: + oneOf: + - type: string + title: price_list_id + description: The product's price list id. + - type: array + description: The product's price list id. + items: + type: string + title: price_list_id + description: The price list id's details. + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: string + title: status + description: The product's status. + - type: array + description: The product's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The product's sales channel id. + - type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product's handle. + - type: array + description: The product's handle. + items: + type: string + title: handle + description: The handle's details. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: false + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: object + description: The product's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + - name: type_id + in: query + required: false + schema: + oneOf: + - type: string + title: type_id + description: The product's type id. + - type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: category_id + in: query + required: false + schema: + oneOf: + - type: string + title: category_id + description: The product's category id. + - type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The product's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The category id's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + - name: categories + in: query + required: false + schema: + oneOf: + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The id's $eq. + - type: object + description: The id's $eq. + x-schemaName: RegExp + - type: array + description: The id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The id's $ne. + - type: object + description: The id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The id's $not. + - type: object + description: The id's $not. + x-schemaName: RegExp + - type: object + description: The id's $not. + - type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The id's $gt. + - type: object + description: The id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The id's $gte. + - type: object + description: The id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The id's $lt. + - type: object + description: The id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The id's $lte. + - type: object + description: The id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - type: object + description: The product's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + properties: + $and: + type: array + description: The id's $and. + items: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + $or: + type: array + description: The id's $or. + items: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + $eq: + oneOf: + - type: array + description: The id's $eq. + items: + type: string + title: $eq + description: The $eq's details. + - type: array + description: The id's $eq. + items: + type: array + description: The $eq's details. + items: + type: string + title: $eq + description: The $eq's details. + $ne: + type: array + description: The id's $ne. + items: + type: string + title: $ne + description: The $ne's details. + $in: + type: array + description: The id's $in. + items: + type: array + description: The $in's details. + items: + type: string + title: $in + description: The $in's details. + $nin: + type: array + description: The id's $nin. + items: + type: array + description: The $nin's details. + items: + type: string + title: $nin + description: The $nin's details. + $not: + type: array + description: The id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + $gt: + type: array + description: The id's $gt. + items: + type: string + title: $gt + description: The $gt's details. + $gte: + type: array + description: The id's $gte. + items: + type: string + title: $gte + description: The $gte's details. + $lt: + type: array + description: The id's $lt. + items: + type: string + title: $lt + description: The $lt's details. + $lte: + type: array + description: The id's $lte. + items: + type: string + title: $lte + description: The $lte's details. + $like: + type: string + title: $like + description: The id's $like. + $re: + type: string + title: $re + description: The id's $re. + $ilike: + type: string + title: $ilike + description: The id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The id's $fulltext. + $overlap: + type: array + description: The id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The id's $exists. + - name: collection_id + in: query + required: false + schema: + oneOf: + - type: string + title: collection_id + description: The product's collection id. + - type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The product's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The collection id's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The created at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The updated at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $and's $eq. + - type: object + description: The $and's $eq. + x-schemaName: RegExp + - type: array + description: The $and's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $and's $ne. + - type: object + description: The $and's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $and's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $and's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $and's $not. + - type: object + description: The $and's $not. + x-schemaName: RegExp + - type: object + description: The $and's $not. + - type: array + description: The $and's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $and's $gt. + - type: object + description: The $and's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $and's $gte. + - type: object + description: The $and's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $and's $lt. + - type: object + description: The $and's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $and's $lte. + - type: object + description: The $and's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $and's $like. + $re: + type: string + title: $re + description: The $and's $re. + $ilike: + type: string + title: $ilike + description: The $and's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $and's $fulltext. + $overlap: + type: array + description: The $and's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $and's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $and's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $and's $exists. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $and's exec. + test: + type: object + description: The $and's test. + source: + type: string + title: source + description: The $and's source. + global: + type: boolean + title: global + description: The $and's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $and's ignorecase. + multiline: + type: boolean + title: multiline + description: The $and's multiline. + lastIndex: + type: number + title: lastIndex + description: The $and's lastindex. + compile: + type: object + description: The $and's compile. + flags: + type: string + title: flags + description: The $and's flags. + sticky: + type: boolean + title: sticky + description: The $and's sticky. + unicode: + type: boolean + title: unicode + description: The $and's unicode. + dotAll: + type: boolean + title: dotAll + description: The $and's dotall. + __@match@1128: + type: object + description: The $and's @match@1128. + __@replace@1130: + type: object + description: The $and's @replace@1130. + __@search@1133: + type: object + description: The $and's @search@1133. + __@split@1135: + type: object + description: The $and's @split@1135. + __@matchAll@1137: + type: object + description: The $and's @matchall@1137. + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $or's $eq. + - type: object + description: The $or's $eq. + x-schemaName: RegExp + - type: array + description: The $or's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $or's $ne. + - type: object + description: The $or's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $or's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $or's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $or's $not. + - type: object + description: The $or's $not. + x-schemaName: RegExp + - type: object + description: The $or's $not. + - type: array + description: The $or's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $or's $gt. + - type: object + description: The $or's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $or's $gte. + - type: object + description: The $or's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $or's $lt. + - type: object + description: The $or's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $or's $lte. + - type: object + description: The $or's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $or's $like. + $re: + type: string + title: $re + description: The $or's $re. + $ilike: + type: string + title: $ilike + description: The $or's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $or's $fulltext. + $overlap: + type: array + description: The $or's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $or's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $or's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $or's $exists. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $or's exec. + test: + type: object + description: The $or's test. + source: + type: string + title: source + description: The $or's source. + global: + type: boolean + title: global + description: The $or's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $or's ignorecase. + multiline: + type: boolean + title: multiline + description: The $or's multiline. + lastIndex: + type: number + title: lastIndex + description: The $or's lastindex. + compile: + type: object + description: The $or's compile. + flags: + type: string + title: flags + description: The $or's flags. + sticky: + type: boolean + title: sticky + description: The $or's sticky. + unicode: + type: boolean + title: unicode + description: The $or's unicode. + dotAll: + type: boolean + title: dotAll + description: The $or's dotall. + __@match@1128: + type: object + description: The $or's @match@1128. + __@replace@1130: + type: object + description: The $or's @replace@1130. + __@search@1133: + type: object + description: The $or's @search@1133. + __@split@1135: + type: object + description: The $or's @split@1135. + __@matchAll@1137: + type: object + description: The $or's @matchall@1137. + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $eq's exec. + test: + type: object + description: The $eq's test. + source: + type: string + title: source + description: The $eq's source. + global: + type: boolean + title: global + description: The $eq's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $eq's ignorecase. + multiline: + type: boolean + title: multiline + description: The $eq's multiline. + lastIndex: + type: number + title: lastIndex + description: The $eq's lastindex. + compile: + type: object + description: The $eq's compile. + flags: + type: string + title: flags + description: The $eq's flags. + sticky: + type: boolean + title: sticky + description: The $eq's sticky. + unicode: + type: boolean + title: unicode + description: The $eq's unicode. + dotAll: + type: boolean + title: dotAll + description: The $eq's dotall. + __@match@1128: + type: object + description: The $eq's @match@1128. + __@replace@1130: + type: object + description: The $eq's @replace@1130. + __@search@1133: + type: object + description: The $eq's @search@1133. + __@split@1135: + type: object + description: The $eq's @split@1135. + __@matchAll@1137: + type: object + description: The $eq's @matchall@1137. + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $ne's exec. + test: + type: object + description: The $ne's test. + source: + type: string + title: source + description: The $ne's source. + global: + type: boolean + title: global + description: The $ne's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $ne's ignorecase. + multiline: + type: boolean + title: multiline + description: The $ne's multiline. + lastIndex: + type: number + title: lastIndex + description: The $ne's lastindex. + compile: + type: object + description: The $ne's compile. + flags: + type: string + title: flags + description: The $ne's flags. + sticky: + type: boolean + title: sticky + description: The $ne's sticky. + unicode: + type: boolean + title: unicode + description: The $ne's unicode. + dotAll: + type: boolean + title: dotAll + description: The $ne's dotall. + __@match@1128: + type: object + description: The $ne's @match@1128. + __@replace@1130: + type: object + description: The $ne's @replace@1130. + __@search@1133: + type: object + description: The $ne's @search@1133. + __@split@1135: + type: object + description: The $ne's @split@1135. + __@matchAll@1137: + type: object + description: The $ne's @matchall@1137. + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $in's exec. + test: + type: object + description: The $in's test. + source: + type: string + title: source + description: The $in's source. + global: + type: boolean + title: global + description: The $in's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $in's ignorecase. + multiline: + type: boolean + title: multiline + description: The $in's multiline. + lastIndex: + type: number + title: lastIndex + description: The $in's lastindex. + compile: + type: object + description: The $in's compile. + flags: + type: string + title: flags + description: The $in's flags. + sticky: + type: boolean + title: sticky + description: The $in's sticky. + unicode: + type: boolean + title: unicode + description: The $in's unicode. + dotAll: + type: boolean + title: dotAll + description: The $in's dotall. + __@match@1128: + type: object + description: The $in's @match@1128. + __@replace@1130: + type: object + description: The $in's @replace@1130. + __@search@1133: + type: object + description: The $in's @search@1133. + __@split@1135: + type: object + description: The $in's @split@1135. + __@matchAll@1137: + type: object + description: The $in's @matchall@1137. + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $nin's exec. + test: + type: object + description: The $nin's test. + source: + type: string + title: source + description: The $nin's source. + global: + type: boolean + title: global + description: The $nin's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $nin's ignorecase. + multiline: + type: boolean + title: multiline + description: The $nin's multiline. + lastIndex: + type: number + title: lastIndex + description: The $nin's lastindex. + compile: + type: object + description: The $nin's compile. + flags: + type: string + title: flags + description: The $nin's flags. + sticky: + type: boolean + title: sticky + description: The $nin's sticky. + unicode: + type: boolean + title: unicode + description: The $nin's unicode. + dotAll: + type: boolean + title: dotAll + description: The $nin's dotall. + __@match@1128: + type: object + description: The $nin's @match@1128. + __@replace@1130: + type: object + description: The $nin's @replace@1130. + __@search@1133: + type: object + description: The $nin's @search@1133. + __@split@1135: + type: object + description: The $nin's @split@1135. + __@matchAll@1137: + type: object + description: The $nin's @matchall@1137. + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + - type: object + description: The deleted at's $not. + properties: + $and: + type: array + description: The $not's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The $not's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The $not's $eq. + - type: object + description: The $not's $eq. + x-schemaName: RegExp + - type: array + description: The $not's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The $not's $ne. + - type: object + description: The $not's $ne. + x-schemaName: RegExp + $in: + type: array + description: The $not's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The $not's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + - type: object + description: The $not's details. + - type: array + description: The $not's details. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The $not's $gt. + - type: object + description: The $not's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The $not's $gte. + - type: object + description: The $not's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The $not's $lt. + - type: object + description: The $not's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The $not's $lte. + - type: object + description: The $not's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The $not's $like. + $re: + type: string + title: $re + description: The $not's $re. + $ilike: + type: string + title: $ilike + description: The $not's $ilike. + $fulltext: + type: string + title: $fulltext + description: The $not's $fulltext. + $overlap: + type: array + description: The $not's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The $not's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The $not's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The $not's $exists. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $not's exec. + test: + type: object + description: The $not's test. + source: + type: string + title: source + description: The $not's source. + global: + type: boolean + title: global + description: The $not's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $not's ignorecase. + multiline: + type: boolean + title: multiline + description: The $not's multiline. + lastIndex: + type: number + title: lastIndex + description: The $not's lastindex. + compile: + type: object + description: The $not's compile. + flags: + type: string + title: flags + description: The $not's flags. + sticky: + type: boolean + title: sticky + description: The $not's sticky. + unicode: + type: boolean + title: unicode + description: The $not's unicode. + dotAll: + type: boolean + title: dotAll + description: The $not's dotall. + __@match@1128: + type: object + description: The $not's @match@1128. + __@replace@1130: + type: object + description: The $not's @replace@1130. + __@search@1133: + type: object + description: The $not's @search@1133. + __@split@1135: + type: object + description: The $not's @split@1135. + __@matchAll@1137: + type: object + description: The $not's @matchall@1137. + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gt's exec. + test: + type: object + description: The $gt's test. + source: + type: string + title: source + description: The $gt's source. + global: + type: boolean + title: global + description: The $gt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gt's lastindex. + compile: + type: object + description: The $gt's compile. + flags: + type: string + title: flags + description: The $gt's flags. + sticky: + type: boolean + title: sticky + description: The $gt's sticky. + unicode: + type: boolean + title: unicode + description: The $gt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gt's dotall. + __@match@1128: + type: object + description: The $gt's @match@1128. + __@replace@1130: + type: object + description: The $gt's @replace@1130. + __@search@1133: + type: object + description: The $gt's @search@1133. + __@split@1135: + type: object + description: The $gt's @split@1135. + __@matchAll@1137: + type: object + description: The $gt's @matchall@1137. + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $gte's exec. + test: + type: object + description: The $gte's test. + source: + type: string + title: source + description: The $gte's source. + global: + type: boolean + title: global + description: The $gte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $gte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $gte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $gte's lastindex. + compile: + type: object + description: The $gte's compile. + flags: + type: string + title: flags + description: The $gte's flags. + sticky: + type: boolean + title: sticky + description: The $gte's sticky. + unicode: + type: boolean + title: unicode + description: The $gte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $gte's dotall. + __@match@1128: + type: object + description: The $gte's @match@1128. + __@replace@1130: + type: object + description: The $gte's @replace@1130. + __@search@1133: + type: object + description: The $gte's @search@1133. + __@split@1135: + type: object + description: The $gte's @split@1135. + __@matchAll@1137: + type: object + description: The $gte's @matchall@1137. + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lt's exec. + test: + type: object + description: The $lt's test. + source: + type: string + title: source + description: The $lt's source. + global: + type: boolean + title: global + description: The $lt's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lt's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lt's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lt's lastindex. + compile: + type: object + description: The $lt's compile. + flags: + type: string + title: flags + description: The $lt's flags. + sticky: + type: boolean + title: sticky + description: The $lt's sticky. + unicode: + type: boolean + title: unicode + description: The $lt's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lt's dotall. + __@match@1128: + type: object + description: The $lt's @match@1128. + __@replace@1130: + type: object + description: The $lt's @replace@1130. + __@search@1133: + type: object + description: The $lt's @search@1133. + __@split@1135: + type: object + description: The $lt's @split@1135. + __@matchAll@1137: + type: object + description: The $lt's @matchall@1137. + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + required: + - exec + - test + - source + - global + - ignoreCase + - multiline + - lastIndex + - flags + - sticky + - unicode + - dotAll + - __@match@1128 + - __@replace@1130 + - __@search@1133 + - __@matchAll@1137 + properties: + exec: + type: object + description: The $lte's exec. + test: + type: object + description: The $lte's test. + source: + type: string + title: source + description: The $lte's source. + global: + type: boolean + title: global + description: The $lte's global. + ignoreCase: + type: boolean + title: ignoreCase + description: The $lte's ignorecase. + multiline: + type: boolean + title: multiline + description: The $lte's multiline. + lastIndex: + type: number + title: lastIndex + description: The $lte's lastindex. + compile: + type: object + description: The $lte's compile. + flags: + type: string + title: flags + description: The $lte's flags. + sticky: + type: boolean + title: sticky + description: The $lte's sticky. + unicode: + type: boolean + title: unicode + description: The $lte's unicode. + dotAll: + type: boolean + title: dotAll + description: The $lte's dotall. + __@match@1128: + type: object + description: The $lte's @match@1128. + __@replace@1130: + type: object + description: The $lte's @replace@1130. + __@search@1133: + type: object + description: The $lte's @search@1133. + __@split@1135: + type: object + description: The $lte's @split@1135. + __@matchAll@1137: + type: object + description: The $lte's @matchall@1137. + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + - name: $and + in: query + description: The product's $and. + required: false + schema: + type: array + description: The product's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + - type: object + description: The category id's $not. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + categories: + oneOf: + - type: object + description: The $and's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + - type: object + description: The $and's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + - type: object + description: The collection id's $not. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + created_at: + type: object + description: The $and's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + - type: object + description: The created at's $not. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + updated_at: + type: object + description: The $and's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + - type: object + description: The updated at's $not. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + deleted_at: + type: object + description: The $and's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + - type: object + description: The deleted at's $not. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - name: $or + in: query + description: The product's $or. + required: false + schema: + type: array + description: The product's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + properties: + value: + type: array + description: The tag's value. + items: + type: string + title: value + description: The value's details. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + properties: + $and: + type: array + description: The category id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The category id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The category id's $eq. + - type: object + description: The category id's $eq. + x-schemaName: RegExp + - type: array + description: The category id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The category id's $ne. + - type: object + description: The category id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The category id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The category id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The category id's $not. + - type: object + description: The category id's $not. + x-schemaName: RegExp + - type: object + description: The category id's $not. + - type: array + description: The category id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The category id's $gt. + - type: object + description: The category id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The category id's $gte. + - type: object + description: The category id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The category id's $lt. + - type: object + description: The category id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The category id's $lte. + - type: object + description: The category id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The category id's $like. + $re: + type: string + title: $re + description: The category id's $re. + $ilike: + type: string + title: $ilike + description: The category id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The category id's $fulltext. + $overlap: + type: array + description: The category id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The category id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The category id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The category id's $exists. + categories: + oneOf: + - type: object + description: The $or's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + - type: object + description: The $or's categories. + required: + - id + properties: + id: + type: object + description: The category's ID. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + properties: + $and: + type: array + description: The collection id's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The collection id's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The collection id's $eq. + - type: object + description: The collection id's $eq. + x-schemaName: RegExp + - type: array + description: The collection id's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The collection id's $ne. + - type: object + description: The collection id's $ne. + x-schemaName: RegExp + $in: + type: array + description: The collection id's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The collection id's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The collection id's $not. + - type: object + description: The collection id's $not. + x-schemaName: RegExp + - type: object + description: The collection id's $not. + - type: array + description: The collection id's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The collection id's $gt. + - type: object + description: The collection id's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The collection id's $gte. + - type: object + description: The collection id's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The collection id's $lt. + - type: object + description: The collection id's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The collection id's $lte. + - type: object + description: The collection id's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The collection id's $like. + $re: + type: string + title: $re + description: The collection id's $re. + $ilike: + type: string + title: $ilike + description: The collection id's $ilike. + $fulltext: + type: string + title: $fulltext + description: The collection id's $fulltext. + $overlap: + type: array + description: The collection id's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The collection id's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The collection id's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The collection id's $exists. + created_at: + type: object + description: The $or's created at. + properties: + $and: + type: array + description: The created at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The created at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The created at's $eq. + - type: object + description: The created at's $eq. + x-schemaName: RegExp + - type: array + description: The created at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The created at's $ne. + - type: object + description: The created at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The created at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The created at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The created at's $not. + - type: object + description: The created at's $not. + x-schemaName: RegExp + - type: object + description: The created at's $not. + - type: array + description: The created at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The created at's $gt. + - type: object + description: The created at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The created at's $gte. + - type: object + description: The created at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The created at's $lt. + - type: object + description: The created at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The created at's $lte. + - type: object + description: The created at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The created at's $like. + $re: + type: string + title: $re + description: The created at's $re. + $ilike: + type: string + title: $ilike + description: The created at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The created at's $fulltext. + $overlap: + type: array + description: The created at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The created at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The created at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The created at's $exists. + updated_at: + type: object + description: The $or's updated at. + properties: + $and: + type: array + description: The updated at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The updated at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The updated at's $eq. + - type: object + description: The updated at's $eq. + x-schemaName: RegExp + - type: array + description: The updated at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The updated at's $ne. + - type: object + description: The updated at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The updated at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The updated at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The updated at's $not. + - type: object + description: The updated at's $not. + x-schemaName: RegExp + - type: object + description: The updated at's $not. + - type: array + description: The updated at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The updated at's $gt. + - type: object + description: The updated at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The updated at's $gte. + - type: object + description: The updated at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The updated at's $lt. + - type: object + description: The updated at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The updated at's $lte. + - type: object + description: The updated at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The updated at's $like. + $re: + type: string + title: $re + description: The updated at's $re. + $ilike: + type: string + title: $ilike + description: The updated at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The updated at's $fulltext. + $overlap: + type: array + description: The updated at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The updated at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The updated at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The updated at's $exists. + deleted_at: + type: object + description: The $or's deleted at. + properties: + $and: + type: array + description: The deleted at's $and. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + - type: object + description: The $and's details. + - type: array + description: The $and's details. + items: + oneOf: + - type: string + title: $and + description: The $and's details. + - type: object + description: The $and's details. + x-schemaName: RegExp + $or: + type: array + description: The deleted at's $or. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + - type: object + description: The $or's details. + - type: array + description: The $or's details. + items: + oneOf: + - type: string + title: $or + description: The $or's details. + - type: object + description: The $or's details. + x-schemaName: RegExp + $eq: + oneOf: + - type: string + title: $eq + description: The deleted at's $eq. + - type: object + description: The deleted at's $eq. + x-schemaName: RegExp + - type: array + description: The deleted at's $eq. + items: + oneOf: + - type: string + title: $eq + description: The $eq's details. + - type: object + description: The $eq's details. + x-schemaName: RegExp + $ne: + oneOf: + - type: string + title: $ne + description: The deleted at's $ne. + - type: object + description: The deleted at's $ne. + x-schemaName: RegExp + $in: + type: array + description: The deleted at's $in. + items: + oneOf: + - type: string + title: $in + description: The $in's details. + - type: object + description: The $in's details. + x-schemaName: RegExp + $nin: + type: array + description: The deleted at's $nin. + items: + oneOf: + - type: string + title: $nin + description: The $nin's details. + - type: object + description: The $nin's details. + x-schemaName: RegExp + $not: + oneOf: + - type: string + title: $not + description: The deleted at's $not. + - type: object + description: The deleted at's $not. + x-schemaName: RegExp + - type: object + description: The deleted at's $not. + - type: array + description: The deleted at's $not. + items: + oneOf: + - type: string + title: $not + description: The $not's details. + - type: object + description: The $not's details. + x-schemaName: RegExp + $gt: + oneOf: + - type: string + title: $gt + description: The deleted at's $gt. + - type: object + description: The deleted at's $gt. + x-schemaName: RegExp + $gte: + oneOf: + - type: string + title: $gte + description: The deleted at's $gte. + - type: object + description: The deleted at's $gte. + x-schemaName: RegExp + $lt: + oneOf: + - type: string + title: $lt + description: The deleted at's $lt. + - type: object + description: The deleted at's $lt. + x-schemaName: RegExp + $lte: + oneOf: + - type: string + title: $lte + description: The deleted at's $lte. + - type: object + description: The deleted at's $lte. + x-schemaName: RegExp + $like: + type: string + title: $like + description: The deleted at's $like. + $re: + type: string + title: $re + description: The deleted at's $re. + $ilike: + type: string + title: $ilike + description: The deleted at's $ilike. + $fulltext: + type: string + title: $fulltext + description: The deleted at's $fulltext. + $overlap: + type: array + description: The deleted at's $overlap. + items: + type: string + title: $overlap + description: The $overlap's details. + $contains: + type: array + description: The deleted at's $contains. + items: + type: string + title: $contains + description: The $contain's $contains. + $contained: + type: array + description: The deleted at's $contained. + items: + type: string + title: $contained + description: The $contained's details. + $exists: + type: boolean + title: $exists + description: The deleted at's $exists. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $and's q. + status: + oneOf: + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: string + title: status + description: The $and's status. + - type: array + description: The $and's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $and's sales channel id. + - type: array + description: The $and's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $and's handle. + - type: array + description: The $and's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $and's is giftcard. + tags: + type: object + description: The $and's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $and's type id. + - type: array + description: The $and's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $and's category id. + - type: array + description: The $and's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $and's category id. + categories: + oneOf: + - type: object + description: The $and's categories. + - type: object + description: The $and's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $and's collection id. + - type: array + description: The $and's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $and's collection id. + created_at: + type: object + description: The $and's created at. + updated_at: + type: object + description: The $and's updated at. + deleted_at: + type: object + description: The $and's deleted at. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + properties: + q: + type: string + title: q + description: The $or's q. + status: + oneOf: + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: string + title: status + description: The $or's status. + - type: array + description: The $or's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + sales_channel_id: + oneOf: + - type: string + title: sales_channel_id + description: The $or's sales channel id. + - type: array + description: The $or's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + handle: + oneOf: + - type: string + title: handle + description: The $or's handle. + - type: array + description: The $or's handle. + items: + type: string + title: handle + description: The handle's details. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + is_giftcard: + type: boolean + title: is_giftcard + description: The $or's is giftcard. + tags: + type: object + description: The $or's tags. + type_id: + oneOf: + - type: string + title: type_id + description: The $or's type id. + - type: array + description: The $or's type id. + items: + type: string + title: type_id + description: The type id's details. + category_id: + oneOf: + - type: string + title: category_id + description: The $or's category id. + - type: array + description: The $or's category id. + items: + type: string + title: category_id + description: The category id's details. + - type: object + description: The $or's category id. + categories: + oneOf: + - type: object + description: The $or's categories. + - type: object + description: The $or's categories. + collection_id: + oneOf: + - type: string + title: collection_id + description: The $or's collection id. + - type: array + description: The $or's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - type: object + description: The $or's collection id. + created_at: + type: object + description: The $or's created at. + updated_at: + type: object + description: The $or's updated at. + deleted_at: + type: object + description: The $or's deleted at. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductListParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductListParams + - type: object + description: The $or's details. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminGetProductsParams.yaml x-codeSamples: - lang: Shell label: cURL @@ -23,6 +13987,41 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - products + properties: + products: + type: array + description: The product's products. + items: + type: object '400': $ref: ../components/responses/400_error.yaml '401': @@ -40,11 +14039,69 @@ post: summary: Create Product description: Create a product. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateProduct.yaml x-codeSamples: - lang: Shell label: cURL @@ -53,6 +14110,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -65,7 +14128,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml new file mode 100644 index 0000000000..de2a173906 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_batch.yaml @@ -0,0 +1,94 @@ +post: + operationId: PostProductsBatch + summary: Create Product + description: Create a product. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchProductRequest.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_products_batch/post.sh + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchProductResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml index a631d54dfa..d616c06322 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,12 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +95,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsId summary: Update a Product @@ -52,10 +107,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateProduct.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +177,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +195,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsId summary: Delete a Product @@ -92,6 +207,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +272,12 @@ delete: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +290,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml index 640e9514b4..aab951f73a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options.yaml @@ -12,6 +12,1087 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + required: false + schema: + oneOf: + - type: string + title: title + description: The product's title. + - type: array + description: The product's title. + items: + type: string + title: title + description: The title's details. + - name: product_id + in: query + required: false + schema: + oneOf: + - type: string + title: product_id + description: The product's product id. + - type: array + description: The product's product id. + items: + type: string + title: product_id + description: The product id's details. + - name: $and + in: query + description: The product's $and. + required: false + schema: + type: array + description: The product's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - name: $or + in: query + description: The product's $or. + required: false + schema: + type: array + description: The product's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $and's title. + - type: array + description: The $and's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + title: + oneOf: + - type: string + title: title + description: The $or's title. + - type: array + description: The $or's title. + items: + type: string + title: title + description: The title's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductOptionParams + - type: object + description: The $or's details. security: - api_token: [] - cookie_auth: [] @@ -24,6 +1105,41 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - product_options + properties: + product_options: + type: array + description: The product's product options. + items: + $ref: ../components/schemas/AdminProductOption.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +1152,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdOptions summary: Add Options to Product @@ -52,10 +1164,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateProductOption.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +1234,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,7 +1252,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 502c75a398..91ceb7be73 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -18,6 +18,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -30,6 +83,12 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductOptionResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -42,10 +101,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdOptionsOption_id summary: Add Options to Product @@ -64,10 +119,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateProductOption.yaml x-codeSamples: - lang: Shell label: cURL @@ -76,6 +189,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -88,10 +207,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsIdOptionsOption_id summary: Remove Options from Product @@ -112,6 +227,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -125,6 +293,12 @@ delete: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductOptionDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -137,7 +311,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml index f471fbcb4c..628b3570f3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,41 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The product's limit. + offset: + type: number + title: offset + description: The product's offset. + count: + type: number + title: count + description: The product's count. + - type: object + description: SUMMARY + required: + - variants + properties: + variants: + type: array + description: The product's variants. + items: + $ref: ../components/schemas/AdminProductVariant.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +124,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdVariants summary: Add Variants to Product @@ -52,10 +136,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateProductVariant.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +206,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,7 +224,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml new file mode 100644 index 0000000000..0423b09d6e --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml @@ -0,0 +1,100 @@ +post: + operationId: PostProductsIdVariantsBatch + summary: Add Variants to Product + description: Add a list of variants to a product. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchProductVariantRequest.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_products_{id}_variants_batch/post.sh + tags: + - Products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminBatchProductVariantResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml new file mode 100644 index 0000000000..ef7012ab4b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -0,0 +1,163 @@ +post: + operationId: PostProductsIdVariantsInventoryItemsBatch + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + x-authenticated: true + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The product's create. + items: + type: object + description: The create's details. + required: + - required_quantity + - inventory_item_id + - variant_id + properties: + required_quantity: + type: number + title: required_quantity + description: The create's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The create's inventory item id. + variant_id: + type: string + title: variant_id + description: The create's variant id. + update: + type: array + description: The product's update. + items: + type: object + description: The update's details. + required: + - required_quantity + - inventory_item_id + - variant_id + properties: + required_quantity: + type: number + title: required_quantity + description: The update's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The update's inventory item id. + variant_id: + type: string + title: variant_id + description: The update's variant id. + delete: + type: array + description: The product's delete. + items: + type: object + description: The delete's details. + required: + - inventory_item_id + - variant_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The delete's inventory item id. + variant_id: + type: string + title: variant_id + description: The delete's variant id. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_variants_inventory-items_batch/post.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml index 30bc5900ee..551fc0ce46 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -18,6 +18,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -30,6 +83,12 @@ get: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductVariantResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -42,10 +101,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostProductsIdVariantsVariant_id summary: Add Variants to Product @@ -64,10 +119,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateProductVariant.yaml x-codeSamples: - lang: Shell label: cURL @@ -77,6 +190,12 @@ post: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -89,10 +208,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteProductsIdVariantsVariant_id summary: Remove Variants from Product @@ -113,6 +228,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -126,6 +294,12 @@ delete: tags: - Products responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminProductVariantDeleteResponse.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -138,7 +312,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml new file mode 100644 index 0000000000..01cce673c7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items.yaml @@ -0,0 +1,103 @@ +post: + operationId: PostProductsIdVariantsVariant_idInventoryItems + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + 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's variant id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateVariantInventoryItem.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items/post.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml new file mode 100644 index 0000000000..168bdfe1d6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}.yaml @@ -0,0 +1,216 @@ +post: + operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id + summary: Add Inventory Items to Product + description: Add a list of inventory items to a product. + 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's variant id. + required: true + schema: + type: string + - name: inventory_item_id + in: path + description: The product's inventory item id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateVariantInventoryItem.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/post.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id + summary: Remove Inventory Items from Product + description: >- + Remove a list of inventory items from a product. This doesn't delete the + Inventory Item, only the association between the Inventory Item and the + product. + 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's variant id. + required: true + schema: + type: string + - name: inventory_item_id + in: path + description: The product's inventory item id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_products_{id}_variants_{variant_id}_inventory-items_{inventory_item_id}/delete.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index 23206360da..199f58a957 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -5,7 +5,222 @@ get: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The promotion's q. + required: false + schema: + type: string + title: q + description: The promotion's q. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The promotion's code. + - type: array + description: The promotion's code. + items: + type: string + title: code + description: The code's details. + - name: campaign_id + in: query + required: false + schema: + oneOf: + - type: string + title: campaign_id + description: The promotion's campaign id. + - type: array + description: The promotion's campaign id. + items: + type: string + title: campaign_id + description: The campaign id's details. + - name: application_method + in: query + description: The promotion's application method. + required: false + schema: + type: object + description: The promotion's application method. + properties: + currency_code: + oneOf: + - type: string + title: currency_code + description: The application method's currency code. + - type: array + description: The application method's currency code. + items: + type: string + title: currency_code + description: The currency code's details. + - name: created_at + in: query + description: The promotion's created at. + required: false + schema: + type: object + description: The promotion's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The promotion's updated at. + required: false + schema: + type: object + description: The promotion's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The promotion's deleted at. + required: false + schema: + type: object + description: The promotion's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +233,8 @@ get: tags: - Promotions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +247,339 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostPromotions summary: Create Promotion description: Create a promotion. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - code + - type + - campaign_id + - application_method + properties: + code: + type: string + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + type: + type: string + enum: + - standard + - buyget + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - value + - currency_code + - max_quantity + - type + - target_type + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -52,6 +588,8 @@ post: tags: - Promotions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +602,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml new file mode 100644 index 0000000000..25032c02a5 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -0,0 +1,111 @@ +get: + operationId: GetPromotionsRuleAttributeOptionsRule_type + summary: List Rule Attribute Options + description: >- + Retrieve a list of rule attribute options in a promotion. The rule attribute + options can be filtered by fields like FILTER FIELDS. The rule attribute + options can also be paginated. + x-authenticated: true + parameters: + - name: rule_type + in: path + description: The promotion's rule type. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: promotion_type + in: query + description: The promotion's promotion type. + required: false + schema: + type: string + title: promotion_type + description: The promotion's promotion type. + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + title: application_method_type + description: The promotion's application method type. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_promotions_rule-attribute-options_{rule_type}/get.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml new file mode 100644 index 0000000000..28f8ef9aae --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -0,0 +1,116 @@ +get: + operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id + summary: 'List ' + description: >- + Retrieve a list of in a promotion. The can be filtered by fields like + FILTER FIELDS. The can also be paginated. + x-authenticated: true + parameters: + - name: rule_type + in: path + description: The promotion's rule type. + required: true + schema: + type: string + - name: rule_attribute_id + in: path + description: The promotion's rule attribute id. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: promotion_type + in: query + description: The promotion's promotion type. + required: false + schema: + type: string + title: promotion_type + description: The promotion's promotion type. + - name: application_method_type + in: query + description: The promotion's application method type. + required: false + schema: + type: string + title: application_method_type + description: The promotion's application method type. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}/get.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml index 3a46dcb59e..9caa91602d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -12,15 +12,63 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminGetPromotionsParams.yaml x-codeSamples: - lang: Shell label: cURL @@ -29,6 +77,8 @@ get: tags: - Promotions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -53,6 +103,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -61,7 +164,266 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostPromotionsPromotionReq.yaml + type: object + description: SUMMARY + required: + - campaign_id + properties: + code: + type: string + title: code + description: The promotion's code. + is_automatic: + type: boolean + title: is_automatic + description: The promotion's is automatic. + type: + type: string + enum: + - standard + - buyget + campaign_id: + type: string + title: campaign_id + description: The promotion's campaign id. + campaign: + type: object + description: The promotion's campaign. + required: + - name + - campaign_identifier + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + required: + - type + - currency_code + properties: + type: + type: string + enum: + - spend + - usage + limit: + type: number + title: limit + description: The budget's limit. + currency_code: + type: string + title: currency_code + description: The budget's currency code. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + application_method: + type: object + description: The promotion's application method. + required: + - description + - max_quantity + - currency_code + - apply_to_quantity + - buy_rules_min_quantity + properties: + description: + type: string + title: description + description: The application method's description. + value: + type: number + title: value + description: The application method's value. + max_quantity: + type: number + title: max_quantity + description: The application method's max quantity. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + type: + type: string + enum: + - fixed + - percentage + target_type: + type: string + enum: + - order + - shipping_methods + - items + allocation: + type: string + enum: + - each + - across + target_rules: + type: array + description: The application method's target rules. + items: + type: object + description: The target rule's target rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The target rule's description. + attribute: + type: string + title: attribute + description: The target rule's attribute. + values: + oneOf: + - type: string + title: values + description: The target rule's values. + - type: array + description: The target rule's values. + items: + type: string + title: values + description: The value's values. + buy_rules: + type: array + description: The application method's buy rules. + items: + type: object + description: The buy rule's buy rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The buy rule's attribute. + values: + oneOf: + - type: string + title: values + description: The buy rule's values. + - type: array + description: The buy rule's values. + items: + type: string + title: values + description: The value's values. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The application method's apply to quantity. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The application method's buy rules min quantity. + rules: + type: array + description: The promotion's rules. + items: + type: object + description: The rule's rules. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The rule's description. + attribute: + type: string + title: attribute + description: The rule's attribute. + values: + oneOf: + - type: string + title: values + description: The rule's values. + - type: array + description: The rule's values. + items: + type: string + title: values + description: The value's values. x-codeSamples: - lang: Shell label: cURL @@ -70,6 +432,8 @@ post: tags: - Promotions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -94,6 +458,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -106,6 +523,8 @@ delete: tags: - Promotions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -118,7 +537,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml new file mode 100644 index 0000000000..7835a4b1ac --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch.yaml @@ -0,0 +1,190 @@ +post: + operationId: PostPromotionsIdBuyRulesBatch + summary: Add Buy Rules to Promotion + description: Add a list of buy rules to a promotion. + x-authenticated: true + parameters: + - name: id + in: path + description: The promotion's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_promotions_{id}_buy-rules_batch/post.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_add.yaml deleted file mode 100644 index 8c8fb1b1e2..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_add.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostPromotionsIdBuyRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_promotions_{id}_buy-rules_batch_add/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_remove.yaml deleted file mode 100644 index 30fe598231..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_buy-rules_batch_remove.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostPromotionsIdBuyRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_promotions_{id}_buy-rules_batch_remove/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml new file mode 100644 index 0000000000..c79e2ede32 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch.yaml @@ -0,0 +1,190 @@ +post: + operationId: PostPromotionsIdRulesBatch + summary: Add Rules to Promotion + description: Add a list of rules to a promotion. + x-authenticated: true + parameters: + - name: id + in: path + description: The promotion's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_promotions_{id}_rules_batch/post.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_add.yaml deleted file mode 100644 index 9ebae9fad6..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_add.yaml +++ /dev/null @@ -1,42 +0,0 @@ -post: - operationId: PostPromotionsIdRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_promotions_{id}_rules_batch_add/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_remove.yaml deleted file mode 100644 index 90673a0fb1..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_remove.yaml +++ /dev/null @@ -1,42 +0,0 @@ -post: - operationId: PostPromotionsIdRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_promotions_{id}_rules_batch_remove/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_update.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_update.yaml deleted file mode 100644 index db61417a0c..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_rules_batch_update.yaml +++ /dev/null @@ -1,42 +0,0 @@ -post: - operationId: PostPromotionsIdRulesBatchUpdate - summary: Add Updates to Promotion - description: Add a list of updates to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/admin_promotions_{id}_rules_batch_update/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml new file mode 100644 index 0000000000..ed851c2267 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch.yaml @@ -0,0 +1,190 @@ +post: + operationId: PostPromotionsIdTargetRulesBatch + summary: Add Target Rules to Promotion + description: Add a list of target rules to a promotion. + x-authenticated: true + parameters: + - name: id + in: path + description: The promotion's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The promotion's create. + items: + type: object + description: The create's details. + required: + - operator + - description + - attribute + - values + properties: + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The create's description. + attribute: + type: string + title: attribute + description: The create's attribute. + values: + oneOf: + - type: string + title: values + description: The create's values. + - type: array + description: The create's values. + items: + type: string + title: values + description: The value's values. + update: + type: array + description: The promotion's update. + items: + type: object + description: The update's details. + required: + - id + - description + - values + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The update's description. + attribute: + type: string + title: attribute + description: The update's attribute. + values: + oneOf: + - type: string + title: values + description: The update's values. + - type: array + description: The update's values. + items: + type: string + title: values + description: The value's values. + delete: + type: array + description: The promotion's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_promotions_{id}_target-rules_batch/post.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_add.yaml deleted file mode 100644 index 6fa2bfbae0..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_add.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostPromotionsIdTargetRulesBatchAdd - summary: Add Adds to Promotion - description: Add a list of adds to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_promotions_{id}_target-rules_batch_add/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_remove.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_remove.yaml deleted file mode 100644 index b0397f6a36..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_target-rules_batch_remove.yaml +++ /dev/null @@ -1,43 +0,0 @@ -post: - operationId: PostPromotionsIdTargetRulesBatchRemove - summary: Add Removes to Promotion - description: Add a list of removes to a promotion. - x-authenticated: true - parameters: - - name: id - in: path - description: The promotion's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_promotions_{id}_target-rules_batch_remove/post.sh - tags: - - Promotions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml new file mode 100644 index 0000000000..f0fca26777 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}_{rule_type}.yaml @@ -0,0 +1,99 @@ +get: + operationId: GetPromotionsIdRule_type + summary: 'List ' + description: >- + Retrieve a list of in a promotion. The can be filtered by fields like + FILTER FIELDS. The can also be paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The promotion's ID. + required: true + schema: + type: string + - name: rule_type + in: path + description: The promotion's rule type. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_promotions_{id}_{rule_type}/get.sh + tags: + - Promotions + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml index 27c0595a7c..13ff489917 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -5,7 +5,217 @@ get: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The region's q. + required: false + schema: + type: string + title: q + description: The region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The region's ID. + - type: array + description: The region's ID. + items: + type: string + title: id + description: The id's ID. + - name: code + in: query + required: false + schema: + oneOf: + - type: string + title: code + description: The region's code. + - type: array + description: The region's code. + items: + type: string + title: code + description: The code's details. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The region's name. + - type: array + description: The region's name. + items: + type: string + title: name + description: The name's details. + - name: created_at + in: query + description: The region's created at. + required: false + schema: + type: object + description: The region's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The region's updated at. + required: false + schema: + type: object + description: The region's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The region's deleted at. + required: false + schema: + type: object + description: The region's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +228,8 @@ get: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +242,109 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostRegions summary: Create Region description: Create a region. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. x-codeSamples: - lang: Shell label: cURL @@ -52,6 +353,8 @@ post: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +367,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml index 6d5e336391..80d2198d42 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostRegionsId summary: Update a Region @@ -52,10 +103,101 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - 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. x-codeSamples: - lang: Shell label: cURL @@ -64,6 +206,8 @@ post: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +220,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteRegionsId summary: Delete a Region @@ -92,6 +232,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +297,8 @@ delete: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +311,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml new file mode 100644 index 0000000000..bb2a5449c0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -0,0 +1,433 @@ +get: + operationId: GetReservations + summary: List Reservations + description: >- + Retrieve a list of reservations. The reservations can be filtered by fields + such as `id`. The reservations can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The reservation's location id. + - type: array + description: The reservation's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: inventory_item_id + in: query + required: false + schema: + oneOf: + - type: string + title: inventory_item_id + description: The reservation's inventory item id. + - type: array + description: The reservation's inventory item id. + items: + type: string + title: inventory_item_id + description: The inventory item id's details. + - name: line_item_id + in: query + required: false + schema: + oneOf: + - type: string + title: line_item_id + description: The reservation's line item id. + - type: array + description: The reservation's line item id. + items: + type: string + title: line_item_id + description: The line item id's details. + - name: created_by + in: query + required: false + schema: + oneOf: + - type: string + title: created_by + description: The reservation's created by. + - type: array + description: The reservation's created by. + items: + type: string + title: created_by + description: The created by's details. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The reservation's description. + - type: object + description: The reservation's description. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: quantity + in: query + description: The reservation's quantity. + required: false + schema: + type: object + description: The reservation's quantity. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: created_at + in: query + description: The reservation's created at. + required: false + schema: + type: object + description: The reservation's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The reservation's updated at. + required: false + schema: + type: object + description: The reservation's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The reservation's deleted at. + required: false + schema: + type: object + description: The reservation's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_reservations/get.sh + tags: + - Reservations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostReservations + summary: Create Reservation + description: Create a reservation. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_reservations/post.sh + tags: + - Reservations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml new file mode 100644 index 0000000000..db5e3e0bab --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -0,0 +1,300 @@ +get: + operationId: GetReservationsId + summary: Get a Reservation + description: >- + Retrieve a reservation by its ID. You can expand the reservation's relations + or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_reservations_{id}/get.sh + tags: + - Reservations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostReservationsId + summary: Update a Reservation + description: Update a reservation's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - description + - metadata + properties: + location_id: + type: string + title: location_id + description: The reservation's location 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_reservations_{id}/post.sh + tags: + - Reservations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteReservationsId + summary: Delete a Reservation + description: Delete a reservation. + x-authenticated: true + parameters: + - name: id + in: path + description: The reservation's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_reservations_{id}/delete.sh + tags: + - Reservations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml new file mode 100644 index 0000000000..b7ca56f2d1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons.yaml @@ -0,0 +1,177 @@ +get: + operationId: GetReturnReasons + summary: List Return Reasons + description: >- + Retrieve a list of return reasons. The return reasons can be filtered by + fields such as `id`. The return reasons can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_return-reasons/get.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostReturnReasons + summary: Create Return Reason + description: Create a return reason. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/CreateOrderReturnReason.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_return-reasons/post.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml new file mode 100644 index 0000000000..2088eadbbf --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -0,0 +1,280 @@ +get: + operationId: GetReturnReasonsId + summary: Get a Return Reason + description: >- + Retrieve a return reason by its ID. You can expand the return reason's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_return-reasons_{id}/get.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostReturnReasonsId + summary: Update a Return Reason + description: Update a return reason's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/UpdateOrderReturnReason.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_return-reasons_{id}/post.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteReturnReasonsId + summary: Delete a Return Reason + description: Delete a return reason. + x-authenticated: true + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_return-reasons_{id}/delete.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml new file mode 100644 index 0000000000..712a7811be --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -0,0 +1,177 @@ +get: + operationId: GetReturns + summary: List Returns + description: >- + Retrieve a list of returns. The returns can be filtered by fields such as + `id`. The returns can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns/get.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostReturns + summary: Create Return + description: Create a return. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReturnsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns/post.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml new file mode 100644 index 0000000000..e5c08aa85d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -0,0 +1,93 @@ +get: + operationId: GetReturnsId + summary: Get a Return + description: >- + Retrieve a return by its ID. You can expand the return's relations or select + the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}/get.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml new file mode 100644 index 0000000000..5f640d88ad --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -0,0 +1,91 @@ +post: + operationId: PostReturnsIdCancel + summary: Add Cancels to Return + description: Add a list of cancels to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_cancel/post.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml new file mode 100644 index 0000000000..8f9b2d0066 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml @@ -0,0 +1,96 @@ +post: + operationId: PostReturnsIdReceive + summary: Add Receives to Return + description: Add a list of receives to a return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminPostReceiveReturnsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_returns_{id}_receive/post.sh + tags: + - Returns + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index 57adb7d9b0..8cdcbaf1d7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml @@ -5,7 +5,247 @@ get: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The sales channel's q. + required: false + schema: + type: string + title: q + description: The sales channel's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The sales channel's ID. + - type: array + description: The sales channel's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The sales channel's name. + - type: array + description: The sales channel's name. + items: + type: string + title: name + description: The name's details. + - name: description + in: query + description: The sales channel's description. + required: false + schema: + type: string + title: description + description: The sales channel's description. + - name: is_disabled + in: query + description: The sales channel's is disabled. + required: true + schema: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + - name: created_at + in: query + description: The sales channel's created at. + required: false + schema: + type: object + description: The sales channel's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The sales channel's updated at. + required: false + schema: + type: object + description: The sales channel's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The sales channel's deleted at. + required: false + schema: + type: object + description: The sales channel's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: location_id + in: query + required: false + schema: + oneOf: + - type: string + title: location_id + description: The sales channel's location id. + - type: array + description: The sales channel's location id. + items: + type: string + title: location_id + description: The location id's details. + - name: publishable_key_id + in: query + required: false + schema: + oneOf: + - type: string + title: publishable_key_id + description: The sales channel's publishable key id. + - type: array + description: The sales channel's publishable key id. + items: + type: string + title: publishable_key_id + description: The publishable key id's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +258,8 @@ get: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +272,74 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostSalesChannels summary: Create Sales Channel description: Create a sales channel. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateSalesChannel.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +348,8 @@ post: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +362,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml index 97dda13b58..85cac53ed0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostSalesChannelsId summary: Update a Sales Channel @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateSalesChannel.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,10 +187,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteSalesChannelsId summary: Delete a Sales Channel @@ -92,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,6 +264,8 @@ delete: tags: - Sales Channels responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -116,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml new file mode 100644 index 0000000000..b70c57f5d3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products.yaml @@ -0,0 +1,112 @@ +post: + operationId: PostSalesChannelsIdProducts + summary: Add Products to Sales Channel + description: Add a list of products to a sales channel. + x-authenticated: true + parameters: + - name: id + in: path + description: The sales channel's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The sales channel's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The sales channel's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_sales-channels_{id}_products/post.sh + tags: + - Sales Channels + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch_add.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch_add.yaml deleted file mode 100644 index cc8db8acd3..0000000000 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}_products_batch_add.yaml +++ /dev/null @@ -1,41 +0,0 @@ -post: - operationId: PostSalesChannelsIdProductsBatchAdd - summary: Add Adds to Sales Channel - description: Add a list of adds to a sales channel. - x-authenticated: true - parameters: - - name: id - in: path - description: The sales channel's ID. - required: true - schema: - type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_sales-channels_{id}_products_batch_add/post.sh - tags: - - Sales Channels - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml new file mode 100644 index 0000000000..55b6e9cb24 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options.yaml @@ -0,0 +1,515 @@ +get: + operationId: GetShippingOptions + summary: List Shipping Options + description: >- + Retrieve a list of shipping options. The shipping options can be filtered by + fields such as `id`. The shipping options can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The shipping option's ID. + - type: array + description: The shipping option's ID. + items: + type: string + title: id + description: The id's ID. + - name: q + in: query + description: The shipping option's q. + required: false + schema: + type: string + title: q + description: The shipping option's q. + - name: service_zone_id + in: query + required: false + schema: + oneOf: + - type: string + title: service_zone_id + description: The shipping option's service zone id. + - type: array + description: The shipping option's service zone id. + items: + type: string + title: service_zone_id + description: The service zone id's details. + - name: shipping_profile_id + in: query + required: false + schema: + oneOf: + - type: string + title: shipping_profile_id + description: The shipping option's shipping profile id. + - type: array + description: The shipping option's shipping profile id. + items: + type: string + title: shipping_profile_id + description: The shipping profile id's details. + - name: provider_id + in: query + required: false + schema: + oneOf: + - type: string + title: provider_id + description: The shipping option's provider id. + - type: array + description: The shipping option's provider id. + items: + type: string + title: provider_id + description: The provider id's details. + - name: shipping_option_type_id + in: query + required: false + schema: + oneOf: + - type: string + title: shipping_option_type_id + description: The shipping option's shipping option type id. + - type: array + description: The shipping option's shipping option type id. + items: + type: string + title: shipping_option_type_id + description: The shipping option type id's details. + - name: created_at + in: query + description: The shipping option's created at. + required: false + schema: + type: object + description: The shipping option's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The shipping option's updated at. + required: false + schema: + type: object + description: The shipping option's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The shipping option's deleted at. + required: false + schema: + type: object + description: The shipping option's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options/get.sh + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The shipping option's limit. + offset: + type: number + title: offset + description: The shipping option's offset. + count: + type: number + title: count + description: The shipping option's count. + - type: object + description: SUMMARY + required: + - shipping_options + properties: + shipping_options: + type: array + description: The shipping option's shipping options. + items: + type: object + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostShippingOptions + summary: Create Shipping Option + description: Create a shipping option. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options/post.sh + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingOptionResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml new file mode 100644 index 0000000000..2023724342 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -0,0 +1,348 @@ +post: + operationId: PostShippingOptionsId + summary: Update a Shipping Option + description: Update a shipping option's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + name: + type: string + title: name + description: The shipping option's name. + 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. + shipping_profile_id: + type: string + title: shipping_profile_id + description: The shipping option's shipping profile 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. + properties: + id: + type: string + title: id + description: The price's ID. + 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. + properties: + id: + type: string + title: id + description: The price's ID. + 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: + oneOf: + - 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. + - type: object + description: The rule's rules. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The rule's ID. + 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. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options_{id}/post.sh + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingOptionResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteShippingOptionsId + summary: Delete a Shipping Option + description: Delete a shipping option. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options_{id}/delete.sh + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingOptionDeleteResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml new file mode 100644 index 0000000000..1dca7e236d --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}_rules_batch.yaml @@ -0,0 +1,184 @@ +post: + operationId: PostShippingOptionsIdRulesBatch + summary: Add Rules to Shipping Option + description: Add a list of rules to a shipping option. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + create: + type: array + description: The shipping option's create. + items: + type: object + description: The create's details. + required: + - operator + - attribute + - value + properties: + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The create's attribute. + value: + oneOf: + - type: string + title: value + description: The create's value. + - type: array + description: The create's value. + items: + type: string + title: value + description: The value's details. + update: + type: array + description: The shipping option's update. + items: + type: object + description: The update's details. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The update's ID. + operator: + type: string + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The update's attribute. + value: + oneOf: + - type: string + title: value + description: The update's value. + - type: array + description: The update's value. + items: + type: string + title: value + description: The value's details. + delete: + type: array + description: The shipping option's delete. + items: + type: string + title: delete + description: The delete's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options_{id}_rules_batch/post.sh + tags: + - Shipping Options + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml new file mode 100644 index 0000000000..2ae46fcfd6 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles.yaml @@ -0,0 +1,377 @@ +get: + operationId: GetShippingProfiles + summary: List Shipping Profiles + description: >- + Retrieve a list of shipping profiles. The shipping profiles can be filtered + by fields such as `id`. The shipping profiles can also be sorted or + paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The shipping profile's ID. + - type: array + description: The shipping profile's ID. + items: + type: string + title: id + description: The id's ID. + - name: q + in: query + description: The shipping profile's q. + required: false + schema: + type: string + title: q + description: The shipping profile's q. + - name: type + in: query + description: The shipping profile's type. + required: false + schema: + type: string + title: type + description: The shipping profile's type. + - name: name + in: query + description: The shipping profile's name. + required: false + schema: + type: string + title: name + description: The shipping profile's name. + - name: created_at + in: query + description: The shipping profile's created at. + required: false + schema: + type: object + description: The shipping profile's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The shipping profile's updated at. + required: false + schema: + type: object + description: The shipping profile's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The shipping profile's deleted at. + required: false + schema: + type: object + description: The shipping profile's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-profiles/get.sh + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + allOf: + - type: object + description: SUMMARY + required: + - limit + - offset + - count + properties: + limit: + type: number + title: limit + description: The shipping profile's limit. + offset: + type: number + title: offset + description: The shipping profile's offset. + count: + type: number + title: count + description: The shipping profile's count. + - type: object + description: SUMMARY + required: + - shipping_profiles + properties: + shipping_profiles: + type: array + description: The shipping profile's shipping profiles. + items: + $ref: ../components/schemas/AdminShippingProfile.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostShippingProfiles + summary: Create Shipping Profile + description: Create a shipping profile. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - type + - metadata + properties: + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-profiles/post.sh + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingProfileResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml new file mode 100644 index 0000000000..e8682a333b --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -0,0 +1,307 @@ +get: + operationId: GetShippingProfilesId + summary: Get a Shipping Profile + description: >- + Retrieve a shipping profile by its ID. You can expand the shipping profile's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-profiles_{id}/get.sh + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingProfileResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostShippingProfilesId + summary: Update a Shipping Profile + description: Update a shipping profile's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + properties: + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-profiles_{id}/post.sh + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingProfileResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteShippingProfilesId + summary: Delete a Shipping Profile + description: Delete a shipping profile. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping profile's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-profiles_{id}/delete.sh + tags: + - Shipping Profiles + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingProfileDeleteResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml index 3f3213681c..85b42c72bb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations.yaml @@ -1,9 +1,320 @@ +get: + operationId: GetStockLocations + summary: List Stock Locations + description: >- + Retrieve a list of stock locations. The stock locations can be filtered by + fields such as `id`. The stock locations can also be sorted or paginated. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The stock location's q. + required: false + schema: + type: string + title: q + description: The stock location's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The stock location's ID. + - type: array + description: The stock location's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The stock location's name. + - type: array + description: The stock location's name. + items: + type: string + title: name + description: The name's details. + - name: address_id + in: query + required: false + schema: + oneOf: + - type: string + title: address_id + description: The stock location's address id. + - type: array + description: The stock location's address id. + items: + type: string + title: address_id + description: The address id's details. + - name: sales_channel_id + in: query + required: false + schema: + oneOf: + - type: string + title: sales_channel_id + description: The stock location's sales channel id. + - type: array + description: The stock location's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: created_at + in: query + description: The stock location's created at. + required: false + schema: + type: object + description: The stock location's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The stock location's updated at. + required: false + schema: + type: object + description: The stock location's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The stock location's deleted at. + required: false + schema: + type: object + description: The stock location's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_stock-locations/get.sh + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml post: operationId: PostStockLocations summary: Create Stock Location description: Create a stock location. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -12,7 +323,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostStockLocationsReq.yaml + $ref: ../components/schemas/AdminCreateStockLocation.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml index 24100d87fe..81c89115bd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -38,6 +91,102 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml +post: + operationId: PostStockLocationsId + summary: Update a Stock Location + description: Update a stock location's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateStockLocation.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_stock-locations_{id}/post.sh + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml delete: operationId: DeleteStockLocationsId summary: Delete a Stock Location @@ -50,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml new file mode 100644 index 0000000000..06b478e3a8 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_fulfillment-sets.yaml @@ -0,0 +1,110 @@ +post: + operationId: PostStockLocationsIdFulfillmentSets + summary: Add Fulfillment Sets to Stock Location + description: Add a list of fulfillment sets to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - name + - type + properties: + name: + type: string + title: name + description: The stock location's name. + type: + type: string + title: type + description: The stock location's type. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_stock-locations_{id}_fulfillment-sets/post.sh + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml new file mode 100644 index 0000000000..99568c34dc --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}_sales-channels.yaml @@ -0,0 +1,113 @@ +post: + operationId: PostStockLocationsIdSalesChannels + summary: Add Sales Channels to Stock Location + description: Add a list of sales channels to a stock location. + x-authenticated: true + parameters: + - name: id + in: path + description: The stock location's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + add: + type: array + description: The stock location's add. + items: + type: string + title: add + description: The add's details. + remove: + type: array + description: The stock location's remove. + items: + type: string + title: remove + description: The remove's details. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_stock-locations_{id}_sales-channels/post.sh + tags: + - Stock Locations + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml index 5e8b33992a..3af0413f0a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -5,7 +5,104 @@ get: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The store's q. + required: false + schema: + type: string + title: q + description: The store's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The store's ID. + - type: array + description: The store's ID. + items: + type: string + title: id + description: The id's ID. + - name: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The store's name. + - type: array + description: The store's name. + items: + type: string + title: name + description: The name's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +115,8 @@ get: tags: - Stores responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,7 +129,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml index 86d8f9d1ec..4f6e4be47d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Stores responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostStoresId summary: Update a Store @@ -52,10 +103,68 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateStore.yaml x-codeSamples: - lang: Shell label: cURL @@ -64,6 +173,8 @@ post: tags: - Stores responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -76,7 +187,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml index 8b95f98131..5ec59e9660 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates.yaml @@ -5,7 +5,225 @@ get: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The tax rate's q. + required: false + schema: + type: string + title: q + description: The tax rate's q. + - name: tax_region_id + in: query + required: false + schema: + oneOf: + - type: string + title: tax_region_id + description: The tax rate's tax region id. + - type: array + description: The tax rate's tax region id. + items: + type: string + title: tax_region_id + description: The tax region id's details. + - type: object + description: The tax rate's tax region id. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: is_default + in: query + required: false + schema: + type: string + enum: + - 'true' + - 'false' + - name: created_at + in: query + description: The tax rate's created at. + required: false + schema: + type: object + description: The tax rate's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The tax rate's updated at. + required: false + schema: + type: object + description: The tax rate's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The tax rate's deleted at. + required: false + schema: + type: object + description: The tax rate's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -18,6 +236,8 @@ get: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,16 +250,65 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostTaxRates summary: Create Tax Rate description: Create a tax rate. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -48,7 +317,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostTaxRatesReq.yaml + $ref: ../components/schemas/AdminCreateTaxRate.yaml x-codeSamples: - lang: Shell label: cURL @@ -57,6 +326,8 @@ post: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml index 0ee80d9166..84e6fbe675 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +91,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostTaxRatesId summary: Update a Tax Rate @@ -52,6 +103,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -60,7 +164,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostTaxRatesTaxRateReq.yaml + $ref: ../components/schemas/AdminUpdateTaxRate.yaml x-codeSamples: - lang: Shell label: cURL @@ -69,6 +173,8 @@ post: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -93,6 +199,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -105,6 +264,8 @@ delete: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -117,7 +278,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml index d09acb0aa6..e681cffd68 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml + $ref: ../components/schemas/AdminCreateTaxRateRule.yaml x-codeSamples: - lang: Shell label: cURL @@ -27,6 +80,8 @@ post: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml index 176dd4f7ee..1daa2011ca 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml @@ -18,6 +18,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -30,6 +83,8 @@ delete: tags: - Tax Rates responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -42,7 +97,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml index b73c29a698..2561d0c55c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions.yaml @@ -1,26 +1,437 @@ -post: - operationId: PostTaxRegions - summary: Create Tax Region - description: Create a tax region. +get: + operationId: GetTaxRegions + summary: List Tax Regions + description: >- + Retrieve a list of tax regions. The tax regions can be filtered by fields + such as `id`. The tax regions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The tax region's q. + required: false + schema: + type: string + title: q + description: The tax region's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The tax region's ID. + - type: array + description: The tax region's ID. + items: + type: string + title: id + description: The id's ID. + - name: country_code + in: query + required: false + schema: + oneOf: + - type: string + title: country_code + description: The tax region's country code. + - type: array + description: The tax region's country code. + items: + type: string + title: country_code + description: The country code's details. + - type: object + description: The tax region's country code. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: province_code + in: query + required: false + schema: + oneOf: + - type: string + title: province_code + description: The tax region's province code. + - type: array + description: The tax region's province code. + items: + type: string + title: province_code + description: The province code's details. + - type: object + description: The tax region's province code. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: parent_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_id + description: The tax region's parent id. + - type: array + description: The tax region's parent id. + items: + type: string + title: parent_id + description: The parent id's details. + - type: object + description: The tax region's parent id. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: created_by + in: query + required: false + schema: + oneOf: + - type: string + title: created_by + description: The tax region's created by. + - type: array + description: The tax region's created by. + items: + type: string + title: created_by + description: The created by's details. + - name: created_at + in: query + description: The tax region's created at. + required: false + schema: + type: object + description: The tax region's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The tax region's updated at. + required: false + schema: + type: object + description: The tax region's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The tax region's deleted at. + required: false + schema: + type: object + description: The tax region's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminPostTaxRegionsReq.yaml x-codeSamples: - lang: Shell label: cURL source: - $ref: ../code_samples/Shell/admin_tax-regions/post.sh + $ref: ../code_samples/Shell/admin_tax-regions/get.sh tags: - Tax Regions responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +post: + operationId: PostTaxRegions + summary: Create Tax Region + description: Create a tax region. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminCreateTaxRegion.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_tax-regions/post.sh + tags: + - Tax Regions + responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml index 3690276227..5e7e124276 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -1,7 +1,9 @@ -delete: - operationId: DeleteTaxRegionsId - summary: Delete a Tax Region - description: Delete a tax region. +get: + operationId: GetTaxRegionsId + summary: Get a Tax Region + description: >- + Retrieve a tax region by its ID. You can expand the tax region's relations + or select the fields that should be returned. x-authenticated: true parameters: - name: id @@ -10,6 +12,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,10 +73,103 @@ delete: - lang: Shell label: cURL source: - $ref: ../code_samples/Shell/admin_tax-regions_{id}/delete.sh + $ref: ../code_samples/Shell/admin_tax-regions_{id}/get.sh tags: - Tax Regions responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteTaxRegionsId + summary: Delete a Tax Region + description: Delete a tax region. + x-authenticated: true + parameters: + - name: id + in: path + description: The tax region's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_tax-regions_{id}/delete.sh + tags: + - Tax Regions + responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -34,7 +182,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml new file mode 100644 index 0000000000..5cc2c863bc --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -0,0 +1,90 @@ +post: + operationId: PostUploads + summary: Create Upload + description: Create a upload. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminGetUploadParams.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_uploads/post.sh + tags: + - Uploads + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml new file mode 100644 index 0000000000..183f152e2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml @@ -0,0 +1,184 @@ +get: + operationId: GetUploadsId + summary: Get a Upload + description: >- + Retrieve a upload by its ID. You can expand the upload's relations or select + the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The upload's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_uploads_{id}/get.sh + tags: + - Uploads + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml +delete: + operationId: DeleteUploadsId + summary: Delete a Upload + description: Delete a upload. + x-authenticated: true + parameters: + - name: id + in: path + description: The upload's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_uploads_{id}/delete.sh + tags: + - Uploads + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_users.yaml b/www/apps/api-reference/specs/admin/paths/admin_users.yaml index 795e7ab513..e8f03205d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -4,12 +4,61 @@ get: description: >- Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -18,6 +67,8 @@ get: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,20 +81,70 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostUsers summary: Create User description: Create a user. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/CreateUser.yaml x-codeSamples: - lang: Shell label: cURL @@ -52,6 +153,8 @@ post: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -64,7 +167,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml index ae816dd4e9..2eab0aaab4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml @@ -4,12 +4,61 @@ get: description: >- Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. - x-authenticated: true - parameters: [] - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -18,6 +67,8 @@ get: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,7 +81,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index 2dad04fe01..ac86697b3b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a user by its ID. You can expand the user's relations or select the fields that should be returned. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -12,10 +12,59 @@ get: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -24,6 +73,8 @@ get: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,15 +87,11 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostUsersId summary: Update a User description: Update a user's details. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -52,15 +99,64 @@ post: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. requestBody: content: application/json: schema: - $ref: ../components/schemas/AdminUpdateUserRequest.yaml + $ref: ../components/schemas/AdminUpdateUser.yaml x-codeSamples: - lang: Shell label: cURL @@ -69,6 +165,8 @@ post: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -85,7 +183,7 @@ delete: operationId: DeleteUsersId summary: Delete a User description: Delete a user. - x-authenticated: true + x-authenticated: false parameters: - name: id in: path @@ -93,10 +191,59 @@ delete: required: true schema: type: string - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -105,6 +252,8 @@ delete: tags: - Users responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -117,7 +266,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml index d09dbe2ab9..9e58262bd1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions.yaml @@ -6,7 +6,88 @@ get: filtered by fields such as `id`. The workflows executions can also be sorted or paginated. x-authenticated: true - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: transaction_id + in: query + required: false + schema: + oneOf: + - type: string + title: transaction_id + description: The workflows execution's transaction id. + - type: array + description: The workflows execution's transaction id. + items: + type: string + title: transaction_id + description: The transaction id's details. + - name: workflow_id + in: query + required: false + schema: + oneOf: + - type: string + title: workflow_id + description: The workflows execution's workflow id. + - type: array + description: The workflows execution's workflow id. + items: + type: string + title: workflow_id + description: The workflow id's details. security: - api_token: [] - cookie_auth: [] @@ -19,6 +100,8 @@ get: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -31,7 +114,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml index 8b661e70ba..c36dc165c2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -24,6 +77,8 @@ get: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,7 +91,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml index 32ebd88ce5..00420a2e45 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostWorkflowsRunReq.yaml + $ref: ../components/schemas/AdminCreateWorkflowsRun.yaml x-codeSamples: - lang: Shell label: cURL @@ -28,6 +81,8 @@ post: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml index 361b573918..c060bf72d6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml + $ref: ../components/schemas/AdminCreateWorkflowsAsyncResponse.yaml x-codeSamples: - lang: Shell label: cURL @@ -28,6 +81,8 @@ post: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml index 441f77b0d8..59b0b97254 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml @@ -10,6 +10,59 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -18,7 +71,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml + $ref: ../components/schemas/AdminCreateWorkflowsAsyncResponse.yaml x-codeSamples: - lang: Shell label: cURL @@ -28,6 +81,8 @@ post: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml index 4189d40fac..63e2b53ec6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_subscribe.yaml @@ -13,6 +13,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -26,6 +79,8 @@ get: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -38,7 +93,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml index ddd1751a6f..d497494789 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml @@ -18,6 +18,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -31,6 +84,8 @@ get: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -43,7 +98,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml index 5105af7214..a51ec0a96b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}_{step_id}_subscribe.yaml @@ -25,6 +25,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. security: - api_token: [] - cookie_auth: [] @@ -38,6 +91,8 @@ get: tags: - Workflows Executions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -50,7 +105,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_complete/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_complete/post.sh new file mode 100644 index 0000000000..a3211d248b --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_complete/post.sh @@ -0,0 +1 @@ +curl -X POST '{backend_url}/store/carts/{id}/complete' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh index 3fab2d4346..bb2d14a189 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh @@ -1 +1,7 @@ -curl -X POST '{backend_url}/store/carts/{id}/line-items' \ No newline at end of file +curl -X POST '{backend_url}/store/carts/{id}/line-items' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "variant_id": "{value}", + "quantity": 3360689747918848, + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh index f59518edc7..f04c8e687e 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh @@ -1 +1,6 @@ -curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ No newline at end of file +curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "quantity": 8980402259623936, + "metadata": {} +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-collections/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-collections/post.sh deleted file mode 100644 index e629d97e0f..0000000000 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-collections/post.sh +++ /dev/null @@ -1 +0,0 @@ -curl -X POST '{backend_url}/store/carts/{id}/payment-collections' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh index 7478eb7ed7..0f0f2fc02c 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_promotions/post.sh @@ -1 +1,7 @@ -curl -X POST '{backend_url}/store/carts/{id}/promotions' \ No newline at end of file +curl -X POST '{backend_url}/store/carts/{id}/promotions' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "promo_codes": [ + "{value}" + ] +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh new file mode 100644 index 0000000000..07ce68901e --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh @@ -0,0 +1,5 @@ +curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "option_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_collections/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_collections/get.sh new file mode 100644 index 0000000000..e4889bbfe4 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_collections/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/collections' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_collections_{id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_collections_{id}/get.sh new file mode 100644 index 0000000000..ab8c55b115 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_collections_{id}/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/collections/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh index 080e5f6f70..ba65801c74 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers/post.sh @@ -1 +1,9 @@ -curl -X POST '{backend_url}/store/customers' \ No newline at end of file +curl -X POST '{backend_url}/store/customers' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "Monserrate.Leannon88@yahoo.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/get.sh index fe3d326466..bab5a014c2 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/get.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/get.sh @@ -1 +1,2 @@ -curl '{backend_url}/store/customers/me' \ No newline at end of file +curl '{backend_url}/store/customers/me' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh new file mode 100644 index 0000000000..c3d541be7f --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh @@ -0,0 +1,9 @@ +curl -X POST '{backend_url}/store/customers/me' \ +-H 'Authorization: Bearer {access_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/get.sh index b410e1d37d..23a27237c0 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/get.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/get.sh @@ -1 +1,2 @@ -curl '{backend_url}/store/customers/me/addresses' \ No newline at end of file +curl '{backend_url}/store/customers/me/addresses' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh index 2106fe7e19..14e804ec9e 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh @@ -1 +1,17 @@ -curl -X POST '{backend_url}/store/customers/me/addresses' +curl -X POST '{backend_url}/store/customers/me/addresses' \ +-H 'Authorization: Bearer {access_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {}, + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "address_name": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh index 9f87b916e6..77fa00de72 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh @@ -1 +1,2 @@ -curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ No newline at end of file +curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh index c7f5cc103a..2b83e998e0 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh @@ -1 +1,2 @@ -curl '{backend_url}/store/customers/me/addresses/{address_id}' \ No newline at end of file +curl '{backend_url}/store/customers/me/addresses/{address_id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh index 476a0feca9..df0d0170d9 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh @@ -1 +1,17 @@ -curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ No newline at end of file +curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ +-H 'Authorization: Bearer {access_token}' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "metadata": {}, + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "address_name": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_orders/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_orders/get.sh new file mode 100644 index 0000000000..720db18f83 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_orders/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/orders' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_orders_{id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_orders_{id}/get.sh new file mode 100644 index 0000000000..53e65a1ab1 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_orders_{id}/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/orders/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh new file mode 100644 index 0000000000..6970aa4767 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-collections/post.sh @@ -0,0 +1,8 @@ +curl -X POST '{backend_url}/store/payment-collections' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "cart_id": "{value}", + "region_id": "{value}", + "currency_code": "{value}", + "amount": 8468325826822144 +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-providers/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-providers/get.sh new file mode 100644 index 0000000000..bd7621e278 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_payment-providers/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/payment-providers' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories/get.sh new file mode 100644 index 0000000000..7539bbd7f5 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/product-categories' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories_{id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories_{id}/get.sh new file mode 100644 index 0000000000..306bde43d6 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_product-categories_{id}/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/product-categories/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_products/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_products/get.sh new file mode 100644 index 0000000000..780cefa2ef --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_products/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/products' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_products_{id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_products_{id}/get.sh new file mode 100644 index 0000000000..cc0cb5bafe --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_products_{id}/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/products/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_regions_{id}_payment-providers/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_regions_{id}_payment-providers/get.sh deleted file mode 100644 index 63c8f20971..0000000000 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_regions_{id}_payment-providers/get.sh +++ /dev/null @@ -1 +0,0 @@ -curl '{backend_url}/store/regions/{id}/payment-providers' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons/get.sh new file mode 100644 index 0000000000..7492fc9b1c --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/return-reasons' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons_{id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons_{id}/get.sh new file mode 100644 index 0000000000..403da097a2 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_return-reasons_{id}/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/return-reasons/{id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh new file mode 100644 index 0000000000..93e9497208 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_return/post.sh @@ -0,0 +1,19 @@ +curl -X POST '{backend_url}/store/return' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "order_id": "{value}", + "items": [ + { + "id": "id_XbfptxUVo2io9EI", + "quantity": 7916429753974784, + "reason_id": "{value}", + "note": "{value}" + } + ], + "return_shipping": { + "option_id": "{value}", + "price": 1068364080349184 + }, + "note": "{value}", + "location_id": "{value}" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options/get.sh new file mode 100644 index 0000000000..e64e0793b5 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options/get.sh @@ -0,0 +1 @@ +curl '{backend_url}/store/shipping-options' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options_{cart_id}/get.sh b/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options_{cart_id}/get.sh deleted file mode 100644 index 86ae6e7eb3..0000000000 --- a/www/apps/api-reference/specs/store/code_samples/Shell/store_shipping-options_{cart_id}/get.sh +++ /dev/null @@ -1 +0,0 @@ -curl '{backend_url}/store/shipping-options/{cart_id}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/components/responses/400_error.yaml b/www/apps/api-reference/specs/store/components/responses/400_error.yaml index b960f05fb4..f37bffa613 100644 --- a/www/apps/api-reference/specs/store/components/responses/400_error.yaml +++ b/www/apps/api-reference/specs/store/components/responses/400_error.yaml @@ -1,14 +1,10 @@ -description: Client Error or Multiple Errors +description: Client Error content: application/json: schema: - oneOf: - - $ref: ../schemas/Error.yaml - - $ref: ../schemas/MultipleErrors.yaml + $ref: ../schemas/Error.yaml examples: not_allowed: $ref: ../examples/not_allowed_error.yaml invalid_data: $ref: ../examples/invalid_data_error.yaml - MultipleErrors: - $ref: ../examples/multiple_errors.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml new file mode 100644 index 0000000000..72b7d36198 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminArchiveOrder +required: + - order_id +properties: + order_id: + type: string + title: order_id + description: The order's order id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductRequest.yaml new file mode 100644 index 0000000000..b747877660 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductRequest.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductRequest +properties: + create: + type: array + description: The product's create. + items: + $ref: ./AdminCreateProduct.yaml + update: + type: array + description: The product's update. + items: + $ref: ./AdminUpdateProduct.yaml + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml new file mode 100644 index 0000000000..ed7d417345 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The product's created. + items: + $ref: ./AdminProduct.yaml + updated: + type: array + description: The product's updated. + items: + $ref: ./AdminProduct.yaml + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantRequest.yaml new file mode 100644 index 0000000000..846c8aea3a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantRequest.yaml @@ -0,0 +1,21 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductVariantRequest +properties: + create: + type: array + description: The product's create. + items: + $ref: ./AdminCreateProductVariant.yaml + update: + type: array + description: The product's update. + items: + $ref: ./AdminUpdateProductVariant.yaml + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml new file mode 100644 index 0000000000..383fe37898 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminBatchProductVariantResponse.yaml @@ -0,0 +1,41 @@ +type: object +description: SUMMARY +x-schemaName: AdminBatchProductVariantResponse +required: + - created + - updated + - deleted +properties: + created: + type: array + description: The product's created. + items: + $ref: ./AdminProductVariant.yaml + updated: + type: array + description: The product's updated. + items: + $ref: ./AdminProductVariant.yaml + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCancelFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCancelFulfillment.yaml new file mode 100644 index 0000000000..57e177eccc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCancelFulfillment.yaml @@ -0,0 +1,3 @@ +type: object +description: SUMMARY +x-schemaName: AdminCancelFulfillment diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml new file mode 100644 index 0000000000..1dc07dbed4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCollection.yaml @@ -0,0 +1,39 @@ +type: object +description: The parent's collection. +x-schemaName: AdminCollection +properties: + id: + type: string + title: id + description: The collection's ID. + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: + type: array + description: The collection's products. + items: + type: object + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml new file mode 100644 index 0000000000..c9efe9e5a2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCompleteOrder.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminCompleteOrder +required: + - order_id +properties: + order_id: + type: string + title: order_id + description: The order's order id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml similarity index 87% rename from www/apps/api-reference/specs/admin/components/schemas/CreateApiKey.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml index ef17e6e6a1..1965ae3238 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateApiKey.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateApiKey.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: CreateApiKey +x-schemaName: AdminCreateApiKey required: - title - type @@ -12,5 +12,5 @@ properties: type: type: string enum: - - secret - publishable + - secret diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml similarity index 56% rename from www/apps/api-reference/specs/store/components/schemas/CreateProductCollection.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml index adfc9a52a2..2a9161c132 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml @@ -1,8 +1,9 @@ type: object description: SUMMARY -x-schemaName: CreateProductCollection +x-schemaName: AdminCreateCollection required: - title + - metadata properties: title: type: string @@ -12,14 +13,6 @@ properties: type: string title: handle description: The collection's handle. - product_ids: - type: array - description: The collection's product ids. - items: - type: string - title: product_ids - description: The product id's product ids. metadata: type: object description: The collection's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml new file mode 100644 index 0000000000..9b448177ad --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomer.yaml @@ -0,0 +1,35 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone + - metadata +properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml similarity index 87% rename from www/apps/api-reference/specs/store/components/schemas/CreateCustomerAddress.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml index 291601e951..744dd0a854 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerAddress.yaml @@ -1,8 +1,19 @@ type: object description: SUMMARY -x-schemaName: CreateCustomerAddress +x-schemaName: AdminCreateCustomerAddress required: - - customer_id + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata properties: address_name: type: string @@ -16,10 +27,6 @@ properties: type: boolean title: is_default_billing description: The customer's is default billing. - customer_id: - type: string - title: customer_id - description: The customer's customer id. company: type: string title: company @@ -63,4 +70,3 @@ properties: metadata: type: object description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml similarity index 59% rename from www/apps/api-reference/specs/store/components/schemas/CreateCustomerGroup.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml index d972fa4040..411237b91f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml @@ -1,8 +1,9 @@ type: object description: SUMMARY -x-schemaName: CreateCustomerGroup +x-schemaName: AdminCreateCustomerGroup required: - name + - metadata properties: name: type: string @@ -11,8 +12,3 @@ properties: metadata: type: object description: The customer group's metadata. - properties: {} - created_by: - type: string - title: created_by - description: The customer group's created by. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml new file mode 100644 index 0000000000..7d1debb06d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -0,0 +1,184 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateFulfillment +required: + - location_id + - provider_id + - delivery_address + - items + - labels + - order + - order_id + - shipping_option_id + - data + - packed_at + - shipped_at + - delivered_at + - canceled_at + - metadata +properties: + location_id: + type: string + title: location_id + description: The fulfillment's location id. + provider_id: + type: string + title: provider_id + description: The fulfillment's provider id. + delivery_address: + type: object + description: The fulfillment's delivery address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + phone: + type: string + title: phone + description: The delivery address's phone. + company: + type: string + title: company + description: The delivery address's company. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + metadata: + type: object + description: The delivery address's metadata. + items: + type: array + description: The fulfillment's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - quantity + - barcode + - line_item_id + - inventory_item_id + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + quantity: + type: number + title: quantity + description: The item's quantity. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + order: + type: object + description: The fulfillment's order. + order_id: + type: string + title: order_id + description: The fulfillment's order id. + shipping_option_id: + type: string + title: shipping_option_id + description: The fulfillment's shipping option id. + data: + type: object + description: The fulfillment's data. + packed_at: + type: string + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The fulfillment's canceled at. + format: date-time + metadata: + type: object + description: The fulfillment's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml similarity index 85% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsReq.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml index f82a0dcb72..bc76085c82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml @@ -1,11 +1,11 @@ type: object description: SUMMARY -x-schemaName: AdminPostPriceListsReq +x-schemaName: AdminCreatePriceList required: - title - description - - type - - prices + - starts_at + - ends_at properties: title: type: string @@ -23,19 +23,31 @@ properties: type: string title: ends_at description: The price list's ends at. - status: {} - type: {} + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. prices: type: array description: The price list's prices. items: type: object description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq required: - currency_code - amount - variant_id + - min_quantity + - max_quantity properties: currency_code: type: string @@ -60,8 +72,3 @@ properties: rules: type: object description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml new file mode 100644 index 0000000000..a582cab145 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml @@ -0,0 +1,148 @@ +type: object +description: The create's details. +x-schemaName: AdminCreateProduct +required: + - title +properties: + title: + type: string + title: title + description: The create's title. + subtitle: + type: string + title: subtitle + description: The create's subtitle. + description: + type: string + title: description + description: The create's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The create's is giftcard. + discountable: + type: boolean + title: discountable + description: The create's discountable. + images: + type: array + description: The create's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The create's thumbnail. + handle: + type: string + title: handle + description: The create's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The create's type id. + collection_id: + type: string + title: collection_id + description: The create's collection id. + categories: + type: array + description: The create's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The create's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The create's options. + items: + $ref: ./AdminCreateProductOption.yaml + variants: + type: array + description: The create's variants. + items: + $ref: ./AdminCreateProductVariant.yaml + sales_channels: + type: array + description: The create's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductOption.yaml new file mode 100644 index 0000000000..156ef7cf2f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductOption.yaml @@ -0,0 +1,18 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateProductOption +required: + - title + - values +properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml new file mode 100644 index 0000000000..16419ecccd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml @@ -0,0 +1,82 @@ +type: object +description: The create's details. +x-schemaName: AdminCreateProductVariant +required: + - title + - prices +properties: + title: + type: string + title: title + description: The create's title. + sku: + type: string + title: sku + description: The create's sku. + ean: + type: string + title: ean + description: The create's ean. + upc: + type: string + title: upc + description: The create's upc. + barcode: + type: string + title: barcode + description: The create's barcode. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The create's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The create's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The create's variant rank. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + prices: + type: array + description: The create's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The create's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml new file mode 100644 index 0000000000..f0178db1e1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml @@ -0,0 +1,23 @@ +type: object +description: The price's prices. +x-schemaName: AdminCreateProductVariantPrice +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. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml new file mode 100644 index 0000000000..95757db18b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateSalesChannel.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateSalesChannel +required: + - name + - description + - metadata +properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml new file mode 100644 index 0000000000..3d5448c4bf --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShipment.yaml @@ -0,0 +1,29 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateShipment +required: + - labels +properties: + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml new file mode 100644 index 0000000000..8e3ef68737 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateStockLocation.yaml @@ -0,0 +1,64 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateStockLocation +required: + - name + - address_id + - metadata +properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml similarity index 92% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesReq.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml index 31f7a9f5ac..0ae78fdda5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml @@ -1,9 +1,10 @@ type: object description: SUMMARY -x-schemaName: AdminPostTaxRatesReq +x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - metadata properties: rate: type: number @@ -19,7 +20,6 @@ properties: items: type: object description: The rule's rules. - x-schemaName: CreateTaxRateRule required: - reference - reference_id @@ -51,4 +51,3 @@ properties: metadata: type: object description: The tax rate's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRateRule.yaml similarity index 85% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRateRule.yaml index 95d4bdec29..46cf869c16 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRateRule.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostTaxRatesTaxRateRulesReq +x-schemaName: AdminCreateTaxRateRule required: - reference - reference_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml new file mode 100644 index 0000000000..34f34c56f2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -0,0 +1,51 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateTaxRegion +required: + - country_code + - province_code + - parent_id + - metadata +properties: + country_code: + type: string + title: country_code + description: The tax region's country code. + province_code: + type: string + title: province_code + description: The tax region's province code. + parent_id: + type: string + title: parent_id + description: The tax region's parent id. + default_tax_rate: + type: object + description: The tax region's default tax rate. + required: + - name + - metadata + properties: + rate: + type: number + title: rate + description: The default tax rate's rate. + code: + type: string + title: code + description: The default tax rate's code. + name: + type: string + title: name + description: The default tax rate's name. + is_combinable: + type: string + enum: + - 'true' + - 'false' + metadata: + type: object + description: The default tax rate's metadata. + metadata: + type: object + description: The tax region's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml new file mode 100644 index 0000000000..6674b16f20 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminCreateVariantInventoryItem +required: + - required_quantity + - inventory_item_id +properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The product's inventory item id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml similarity index 74% rename from www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml index 21dd2c9bf9..969982fcb4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsAsyncResponse.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostWorkflowsAsyncResponseReq +x-schemaName: AdminCreateWorkflowsAsyncResponse required: - transaction_id - step_id @@ -15,4 +15,8 @@ properties: description: The workflows execution's step id. response: {} compensate_input: {} - action: {} + action: + type: string + enum: + - invoke + - compensate diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsRunReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsRun.yaml similarity index 82% rename from www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsRunReq.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsRun.yaml index f54c4288d4..9d4e5dc6f3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsRunReq.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateWorkflowsRun.yaml @@ -1,6 +1,6 @@ type: object description: SUMMARY -x-schemaName: AdminPostWorkflowsRunReq +x-schemaName: AdminCreateWorkflowsRun properties: input: {} transaction_id: diff --git a/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml similarity index 56% rename from www/apps/api-reference/specs/admin/components/schemas/Customer.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml index 063a4ff87a..f1f78d98b3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml @@ -1,7 +1,26 @@ type: object -description: The context's customer. -x-schemaName: Customer +description: The customer's details. +x-schemaName: AdminCustomer +required: + - has_account + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses properties: + has_account: + type: boolean + title: has_account + description: The customer's has account. + groups: + type: array + description: The customer's groups. + items: + $ref: ./AdminCustomerGroup.yaml id: type: string title: id @@ -35,53 +54,30 @@ properties: type: array description: The customer's addresses. items: - type: object - description: The address's addresses. - x-schemaName: CustomerAddress - properties: {} + $ref: ./BaseCustomerAddress.yaml phone: type: string title: phone description: The customer's phone. - groups: - type: array - description: The customer's groups. - items: - type: object - description: The group's groups. - properties: {} metadata: type: object description: The customer's metadata. - properties: {} created_by: type: string title: created_by description: The customer's created by. deleted_at: - oneOf: - - type: string - title: deleted_at - description: The customer's deleted at. - - type: string - title: deleted_at - description: The customer's deleted at. - format: date-time + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. created_at: - oneOf: - - type: string - title: created_at - description: The customer's created at. - - type: string - title: created_at - description: The customer's created at. - format: date-time + type: string + format: date-time + title: created_at + description: The customer's created at. updated_at: - oneOf: - - type: string - title: updated_at - description: The customer's updated at. - - type: string - title: updated_at - description: The customer's updated at. - format: date-time + type: string + format: date-time + title: updated_at + description: The customer's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml new file mode 100644 index 0000000000..c4610e86ec --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml @@ -0,0 +1,37 @@ +type: object +description: The group's groups. +x-schemaName: AdminCustomerGroup +required: + - id + - name + - customers + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The group's ID. + name: + type: string + title: name + description: The group's name. + customers: + type: array + description: The group's customers. + items: + $ref: ./BaseCustomer.yaml + metadata: + type: object + description: The group's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The group's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The group's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml deleted file mode 100644 index a391a2918f..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq -properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml new file mode 100644 index 0000000000..9d7d2c4f6a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentProvider.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's provider. +x-schemaName: AdminFulfillmentProvider diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml new file mode 100644 index 0000000000..bff56cf421 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml @@ -0,0 +1,44 @@ +type: object +description: The fulfillment set's details. +x-schemaName: AdminFulfillmentSet +required: + - id + - name + - type + - service_zones + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The fulfillment set's ID. + name: + type: string + title: name + description: The fulfillment set's name. + type: + type: string + title: type + description: The fulfillment set's type. + service_zones: + type: array + description: The fulfillment set's service zones. + items: + $ref: ./AdminServiceZone.yaml + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment set's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment set's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment set's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml new file mode 100644 index 0000000000..e21a663cda --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentSetDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + default: fulfillment_set + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml new file mode 100644 index 0000000000..b5f823157e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminFulfillmentSetResponse +required: + - fulfillment_set +properties: + fulfillment_set: + $ref: ./AdminFulfillmentSet.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml new file mode 100644 index 0000000000..6684ce0d57 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml @@ -0,0 +1,3 @@ +type: object +description: The geo zone's geo zones. +x-schemaName: AdminGeoZone diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesParams.yaml deleted file mode 100644 index 26145b7de3..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesParams.yaml +++ /dev/null @@ -1,31 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPricingRuleTypesParams -properties: - rule_attribute: - type: array - description: The pricing's rule attribute. - items: - type: string - title: rule_attribute - description: The rule attribute's details. - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - offset: - type: number - title: offset - description: The pricing's offset. - limit: - type: number - title: limit - description: The pricing's limit. - order: - type: string - title: order - description: The pricing's order. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml deleted file mode 100644 index d50e3cf0bf..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml +++ /dev/null @@ -1,12 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPricingRuleTypesRuleTypeParams -properties: - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetProductsParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetProductsParams.yaml deleted file mode 100644 index 93db8609d9..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGetProductsParams.yaml +++ /dev/null @@ -1,767 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetProductsParams -properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The product's status. - items: {} - title: - type: string - title: title - description: The product's title. - handle: - type: string - title: handle - description: The product's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - price_list_id: - type: array - description: The product's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The product's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The product's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The product's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The product's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The product's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The product's expand. - fields: - type: string - title: fields - description: The product's fields. - offset: - type: number - title: offset - description: The product's offset. - limit: - type: number - title: limit - description: The product's limit. - order: - type: string - title: order - description: The product's order. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetPromotionsParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPromotionsParams.yaml deleted file mode 100644 index a38aac4435..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGetPromotionsParams.yaml +++ /dev/null @@ -1,28 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminGetPromotionsParams -properties: - code: - type: string - title: code - description: The promotion's code. - expand: - type: string - title: expand - description: The promotion's expand. - fields: - type: string - title: fields - description: The promotion's fields. - offset: - type: number - title: offset - description: The promotion's offset. - limit: - type: number - title: limit - description: The promotion's limit. - order: - type: string - title: order - description: The promotion's order. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml new file mode 100644 index 0000000000..16e5d808f7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminGetUploadParams.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminGetUploadParams +properties: + fields: + type: string + title: fields + description: The upload's fields. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml new file mode 100644 index 0000000000..849a186934 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCancelFulfillment.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCancelFulfillment +properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml new file mode 100644 index 0000000000..59a7bc492a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateFulfillment.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCreateFulfillment +required: + - items + - location_id + - metadata +properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml new file mode 100644 index 0000000000..75ce832164 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderCreateShipment.yaml @@ -0,0 +1,55 @@ +type: object +description: SUMMARY +x-schemaName: AdminOrderCreateShipment +required: + - items + - metadata +properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCampaignsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCampaignsReq.yaml deleted file mode 100644 index 2794f6b7b3..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCampaignsReq.yaml +++ /dev/null @@ -1,46 +0,0 @@ -type: object -description: The promotion's campaign. -x-schemaName: AdminPostCampaignsReq -required: - - name -properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. - budget: - $ref: ./CampaignBudget.yaml - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - x-schemaName: IdObject - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml deleted file mode 100644 index b6d536cac5..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq -required: - - customer_ids -properties: - customer_ids: - type: array - description: The customer group's customer ids. - items: - type: object - description: The customer id's customer ids. - x-schemaName: CustomerGroupsBatchCustomer - required: - - id - properties: - id: - type: string - title: id - description: The customer id's ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml deleted file mode 100644 index ed87f2705e..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml +++ /dev/null @@ -1,34 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq -required: - - rules -properties: - rules: - type: array - description: The fulfillment's rules. - items: - type: object - description: The rule's rules. - x-schemaName: FulfillmentRuleCreate - required: - - operator - - attribute - - value - properties: - operator: {} - 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml deleted file mode 100644 index dcfdf3d238..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq -required: - - rule_ids -properties: - rule_ids: - type: array - description: The fulfillment's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml deleted file mode 100644 index bf0295b65b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml +++ /dev/null @@ -1,56 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsInventoryItemReq -properties: - sku: - type: string - title: sku - description: The inventory item's sku. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - 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. - weight: - type: number - title: weight - description: The inventory item's weight. - height: - type: number - title: height - description: The inventory item's height. - length: - type: number - title: length - description: The inventory item's length. - width: - type: number - title: width - description: The inventory item's width. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml deleted file mode 100644 index 444b8870c0..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml +++ /dev/null @@ -1,12 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq -properties: - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml deleted file mode 100644 index 0bdd7938fe..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq -required: - - location_id - - stocked_quantity -properties: - location_id: - type: string - title: location_id - description: The inventory item's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsReq.yaml deleted file mode 100644 index d97997e360..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsReq.yaml +++ /dev/null @@ -1,56 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInventoryItemsReq -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. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - metadata: - type: object - description: The inventory item's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostInvitesInviteAcceptReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInvitesInviteAcceptReq.yaml deleted file mode 100644 index 0843980500..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostInvitesInviteAcceptReq.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostInvitesInviteAcceptReq -required: - - first_name - - last_name -properties: - first_name: - type: string - title: first_name - description: The invite's first name. - last_name: - type: string - title: last_name - description: The invite's last name. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsCapturesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsCapturesReq.yaml deleted file mode 100644 index aa5a8cc8bc..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsCapturesReq.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPaymentsCapturesReq -properties: - amount: - type: number - title: amount - description: The payment's amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsRefundsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsRefundsReq.yaml deleted file mode 100644 index 8afa44416d..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsRefundsReq.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPaymentsRefundsReq -properties: - amount: - type: number - title: amount - description: The payment's amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml deleted file mode 100644 index 57b5300434..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml +++ /dev/null @@ -1,42 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq -required: - - prices -properties: - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml deleted file mode 100644 index 7e3adbbf6a..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq -required: - - ids -properties: - ids: - type: array - description: The price list's ids. - items: - type: string - title: ids - description: The id's ids. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListReq.yaml deleted file mode 100644 index 544cae040d..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListReq.yaml +++ /dev/null @@ -1,64 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPriceListsPriceListReq -required: - - prices -properties: - title: - type: string - title: title - description: The price list's title. - description: - type: string - title: description - description: The price list's description. - starts_at: - type: string - title: starts_at - description: The price list's starts at. - ends_at: - type: string - title: ends_at - description: The price list's ends at. - status: {} - type: {} - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesReq.yaml deleted file mode 100644 index 4913c040f5..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPricingRuleTypesReq -required: - - name - - rule_attribute - - default_priority -properties: - name: - type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml deleted file mode 100644 index 0639dbbadc..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml +++ /dev/null @@ -1,16 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPricingRuleTypesRuleTypeReq -properties: - name: - type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionReq.yaml deleted file mode 100644 index a00d8d6922..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionReq.yaml +++ /dev/null @@ -1,49 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionReq -properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - type: {} - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - $ref: ./AdminPostCampaignsReq.yaml - application_method: - $ref: ./ApplicationMethodsMethodPostReq.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml deleted file mode 100644 index cfa30aaeb4..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml +++ /dev/null @@ -1,34 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq -required: - - rules -properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml deleted file mode 100644 index 2b74ae724d..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml +++ /dev/null @@ -1,13 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq -required: - - rule_ids -properties: - rule_ids: - type: array - description: The promotion's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml deleted file mode 100644 index cbe025b43c..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml +++ /dev/null @@ -1,38 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq -required: - - rules -properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: UpdatePromotionRule - required: - - id - - attribute - - values - properties: - id: - type: string - title: id - description: The rule's ID. - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml new file mode 100644 index 0000000000..d097909bcc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -0,0 +1,44 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReceiveReturnsReqSchema +required: + - return_id + - items + - internal_note +properties: + return_id: + type: string + title: return_id + description: The return's return id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + internal_note: + type: string + title: internal_note + description: The return's internal note. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml new file mode 100644 index 0000000000..6f178e3e31 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml @@ -0,0 +1,72 @@ +type: object +description: SUMMARY +x-schemaName: AdminPostReturnsReqSchema +required: + - order_id + - items + - return_shipping + - internal_note + - location_id +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + internal_note: + type: string + title: internal_note + description: The return's internal note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostStockLocationsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostStockLocationsReq.yaml deleted file mode 100644 index a8c1dac40b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostStockLocationsReq.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostStockLocationsReq -required: - - name -properties: - name: - type: string - title: name - description: The stock location's name. - address: - $ref: ./StockLocationAddress.yaml - address_id: - type: string - title: address_id - description: The stock location's address id. - metadata: - type: object - description: The stock location's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateReq.yaml deleted file mode 100644 index a6c334bdc6..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateReq.yaml +++ /dev/null @@ -1,41 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostTaxRatesTaxRateReq -properties: - code: - type: string - title: code - description: The tax rate's code. - name: - type: string - title: name - description: The tax rate's name. - region_id: - type: string - title: region_id - description: The tax rate's region id. - rate: - type: number - title: rate - description: The tax rate's rate. - products: - type: array - description: The tax rate's products. - items: - type: string - title: products - description: The product's products. - shipping_options: - type: array - description: The tax rate's shipping options. - items: - type: string - title: shipping_options - description: The shipping option's shipping options. - product_types: - type: array - description: The tax rate's product types. - items: - type: string - title: product_types - description: The product type's product types. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRegionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRegionsReq.yaml deleted file mode 100644 index 74c8a85d31..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRegionsReq.yaml +++ /dev/null @@ -1,24 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminPostTaxRegionsReq -required: - - country_code -properties: - country_code: - type: string - title: country_code - description: The tax region's country code. - province_code: - type: string - title: province_code - description: The tax region's province code. - parent_id: - type: string - title: parent_id - description: The tax region's parent id. - default_tax_rate: - $ref: ./CreateDefaultTaxRate.yaml - metadata: - type: object - description: The tax region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml new file mode 100644 index 0000000000..c63019f47d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPrice.yaml @@ -0,0 +1,62 @@ +type: object +description: The price's prices. +x-schemaName: AdminPrice +required: + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml new file mode 100644 index 0000000000..f4ae136c2c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -0,0 +1,167 @@ +type: object +description: The product's parent. +x-schemaName: AdminProduct +required: + - type + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id +properties: + collection: + $ref: ./AdminCollection.yaml + categories: + type: array + description: The parent's categories. + items: + $ref: ./AdminProductCategory.yaml + sales_channels: + type: array + description: The parent's sales channels. + items: + $ref: ./AdminSalesChannel.yaml + variants: + type: array + description: The parent's variants. + items: + $ref: ./AdminProductVariant.yaml + type: + type: object + title: + type: string + title: title + description: The parent's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The parent's length. + options: + type: array + description: The parent's options. + items: + $ref: ./BaseProductOption.yaml + description: + type: string + title: description + description: The parent's description. + id: + type: string + title: id + description: The parent's ID. + handle: + type: string + title: handle + description: The parent's handle. + metadata: + type: object + description: The parent's metadata. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + width: + type: number + title: width + description: The parent's width. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. + subtitle: + type: string + title: subtitle + description: The parent's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The parent's is giftcard. + collection_id: + type: string + title: collection_id + description: The parent's collection id. + type_id: + type: string + title: type_id + description: The parent's type id. + tags: + type: array + description: The parent's tags. + items: + $ref: ./BaseProductTag.yaml + images: + type: array + description: The parent's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The parent's discountable. + external_id: + type: string + title: external_id + description: The parent's external id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml new file mode 100644 index 0000000000..1de3721e0e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategory.yaml @@ -0,0 +1,77 @@ +type: object +description: The category's categories. +x-schemaName: AdminProductCategory +required: + - category_children + - parent_category + - name + - description + - id + - handle + - created_at + - updated_at + - deleted_at + - parent_category_id + - is_internal + - is_active + - rank +properties: + category_children: + type: array + description: The category's category children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + handle: + type: string + title: handle + description: The category's handle. + created_at: + type: string + format: date-time + title: created_at + description: The category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The category's deleted at. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. + is_active: + type: boolean + title: is_active + description: The category's is active. + rank: + type: number + title: rank + description: The category's rank. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml new file mode 100644 index 0000000000..542fca2356 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryListResponse +required: + - limit + - offset + - count + - product_categories +properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml new file mode 100644 index 0000000000..b46adcf4e2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductCategoryResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductCategoryResponse +required: + - product_category +properties: + product_category: + $ref: ./AdminProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml new file mode 100644 index 0000000000..65b2edf6c2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + type: object + description: The product's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml new file mode 100644 index 0000000000..bb9c3717ae --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml @@ -0,0 +1,44 @@ +type: object +description: The product's product option. +x-schemaName: AdminProductOption +required: + - id + - title +properties: + id: + type: string + title: id + description: The product option's ID. + title: + type: string + title: title + description: The product option's title. + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The product option's product id. + values: + type: array + description: The product option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The product option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product option's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml new file mode 100644 index 0000000000..c67be976b3 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductOptionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product_option + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml new file mode 100644 index 0000000000..c609e7d1d8 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductOptionResponse +required: + - product_option +properties: + product_option: + $ref: ./AdminProductOption.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml new file mode 100644 index 0000000000..1c3d489857 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductResponse +required: + - product +properties: + product: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml new file mode 100644 index 0000000000..a5255e3ae5 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -0,0 +1,128 @@ +type: object +description: The updated's details. +x-schemaName: AdminProductVariant +required: + - prices + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at +properties: + prices: + type: array + description: The updated's prices. + items: + $ref: ./AdminPrice.yaml + id: + type: string + title: id + description: The updated's ID. + title: + type: string + title: title + description: The updated's title. + sku: + type: string + title: sku + description: The updated's sku. + barcode: + type: string + title: barcode + description: The updated's barcode. + ean: + type: string + title: ean + description: The updated's ean. + upc: + type: string + title: upc + description: The updated's upc. + allow_backorder: + type: boolean + title: allow_backorder + description: The updated's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The updated's manage inventory. + hs_code: + type: string + title: hs_code + description: The updated's hs code. + origin_country: + type: string + title: origin_country + description: The updated's origin country. + mid_code: + type: string + title: mid_code + description: The updated's mid code. + material: + type: string + title: material + description: The updated's material. + weight: + type: number + title: weight + description: The updated's weight. + length: + type: number + title: length + description: The updated's length. + height: + type: number + title: height + description: The updated's height. + width: + type: number + title: width + description: The updated's width. + options: + type: array + description: The updated's options. + items: + $ref: ./BaseProductOptionValue.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The updated's product id. + variant_rank: + type: number + title: variant_rank + description: The updated's variant rank. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. + metadata: + type: object + description: The updated's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml new file mode 100644 index 0000000000..dc3b12dd34 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: variant + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml new file mode 100644 index 0000000000..a6a154c417 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml @@ -0,0 +1,276 @@ +type: object +description: The product's variants. +x-schemaName: AdminProductVariantParams +properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant's fields. + $and: + type: array + description: The variant's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $and's sku. + - type: array + description: The $and's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $and's options. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + $or: + type: array + description: The variant's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $or's sku. + - type: array + description: The $or's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $or's options. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml new file mode 100644 index 0000000000..cb5298721d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminProductVariantResponse +required: + - variant +properties: + variant: + $ref: ./AdminProductVariant.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml new file mode 100644 index 0000000000..7e99903e5b --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminRevokeApiKey +properties: + revoke_in: + type: number + title: revoke_in + description: The api key's revoke in. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml new file mode 100644 index 0000000000..4fb73f820d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml @@ -0,0 +1,47 @@ +type: object +description: The sales channel's sales channels. +x-schemaName: AdminSalesChannel +required: + - id + - name + - description + - is_disabled + - metadata + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The sales channel's ID. + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The sales channel's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The sales channel's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The sales channel's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml new file mode 100644 index 0000000000..d3a3547a06 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml @@ -0,0 +1,50 @@ +type: object +description: The service zone's service zones. +x-schemaName: AdminServiceZone +required: + - id + - name + - fulfillment_set_id + - geo_zones + - shipping_options + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The service zone's ID. + name: + type: string + title: name + description: The service zone's name. + fulfillment_set_id: + type: string + title: fulfillment_set_id + description: The service zone's fulfillment set id. + geo_zones: + type: array + description: The service zone's geo zones. + items: + $ref: ./AdminGeoZone.yaml + shipping_options: + type: array + description: The service zone's shipping options. + items: + $ref: ./AdminShippingOption.yaml + created_at: + type: string + format: date-time + title: created_at + description: The service zone's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The service zone's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The service zone's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml new file mode 100644 index 0000000000..dd8ff8c8d1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminServiceZoneResponse +required: + - service_zone +properties: + service_zone: + $ref: ./AdminServiceZone.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml new file mode 100644 index 0000000000..219dac6bdc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's shipping options. +x-schemaName: AdminShippingOption diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml new file mode 100644 index 0000000000..4581ba2a6a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingOptionDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The shipping option's ID. + object: + type: string + title: object + description: The shipping option's object. + default: shipping_option + deleted: + type: boolean + title: deleted + description: The shipping option's deleted. + parent: + type: object + description: The shipping option's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml new file mode 100644 index 0000000000..dba509d7fd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingOptionResponse +required: + - shipping_option +properties: + shipping_option: + $ref: ./AdminShippingOption.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml new file mode 100644 index 0000000000..29549d5ff2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml @@ -0,0 +1,3 @@ +type: object +description: The shipping option's shipping profile. +x-schemaName: AdminShippingProfile diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml new file mode 100644 index 0000000000..edbadf9d4d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -0,0 +1,24 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingProfileDeleteResponse +required: + - id + - object + - deleted +properties: + id: + type: string + title: id + description: The shipping profile's ID. + object: + type: string + title: object + description: The shipping profile's object. + default: shipping_profile + deleted: + type: boolean + title: deleted + description: The shipping profile's deleted. + parent: + type: object + description: The shipping profile's parent. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml new file mode 100644 index 0000000000..ce83a08372 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: AdminShippingProfileResponse +required: + - shipping_profile +properties: + shipping_profile: + $ref: ./AdminShippingProfile.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml similarity index 70% rename from www/apps/api-reference/specs/admin/components/schemas/UpdateApiKey.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml index 8587ad9fe0..1858893589 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateApiKey.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml @@ -1,6 +1,8 @@ type: object description: SUMMARY -x-schemaName: UpdateApiKey +x-schemaName: AdminUpdateApiKey +required: + - title properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCampaign.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml similarity index 77% rename from www/apps/api-reference/specs/store/components/schemas/CreateCampaign.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml index 46bc1b1324..68b337aeb7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCampaign.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCampaign.yaml @@ -1,9 +1,8 @@ type: object -description: The promotion's campaign. -x-schemaName: CreateCampaign +description: SUMMARY +x-schemaName: AdminUpdateCampaign required: - - name - - campaign_identifier + - description - starts_at - ends_at properties: @@ -11,18 +10,22 @@ properties: type: string title: name description: The campaign's name. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. campaign_identifier: type: string title: campaign_identifier description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + properties: + limit: + type: number + title: limit + description: The budget's limit. starts_at: type: string title: starts_at @@ -33,15 +36,12 @@ properties: title: ends_at description: The campaign's ends at. format: date-time - budget: - $ref: ./CreateCampaignBudget.yaml promotions: type: array description: The campaign's promotions. items: type: object description: The promotion's promotions. - x-schemaName: Promotion required: - id properties: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml new file mode 100644 index 0000000000..a1a589243a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml @@ -0,0 +1,17 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateCollection +required: + - metadata +properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml new file mode 100644 index 0000000000..81d0b149a0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomer.yaml @@ -0,0 +1,35 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone + - metadata +properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml similarity index 59% rename from www/apps/api-reference/specs/admin/components/schemas/CreateCustomerGroup.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml index d972fa4040..b8e6cbca87 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,8 +1,9 @@ type: object description: SUMMARY -x-schemaName: CreateCustomerGroup +x-schemaName: AdminUpdateCustomerGroup required: - name + - metadata properties: name: type: string @@ -11,8 +12,3 @@ properties: metadata: type: object description: The customer group's metadata. - properties: {} - created_by: - type: string - title: created_by - description: The customer group's created by. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml new file mode 100644 index 0000000000..f6929dd104 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml @@ -0,0 +1,37 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdatePriceList +required: + - description + - starts_at + - ends_at +properties: + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml new file mode 100644 index 0000000000..b95015d041 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml @@ -0,0 +1,146 @@ +type: object +description: The update's details. +x-schemaName: AdminUpdateProduct +properties: + title: + type: string + title: title + description: The update's title. + subtitle: + type: string + title: subtitle + description: The update's subtitle. + description: + type: string + title: description + description: The update's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The update's is giftcard. + discountable: + type: boolean + title: discountable + description: The update's discountable. + images: + type: array + description: The update's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The update's thumbnail. + handle: + type: string + title: handle + description: The update's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The update's type id. + collection_id: + type: string + title: collection_id + description: The update's collection id. + categories: + type: array + description: The update's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The update's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The update's options. + items: + $ref: ./AdminUpdateProductOption.yaml + variants: + type: array + description: The update's variants. + items: + $ref: ./AdminCreateProductVariant.yaml + sales_channels: + type: array + description: The update's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml new file mode 100644 index 0000000000..bfdca1a5cb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml @@ -0,0 +1,15 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateProductOption +properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml new file mode 100644 index 0000000000..c0429b85e9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml @@ -0,0 +1,79 @@ +type: object +description: The update's details. +x-schemaName: AdminUpdateProductVariant +properties: + title: + type: string + title: title + description: The update's title. + sku: + type: string + title: sku + description: The update's sku. + ean: + type: string + title: ean + description: The update's ean. + upc: + type: string + title: upc + description: The update's upc. + barcode: + type: string + title: barcode + description: The update's barcode. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The update's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The update's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The update's variant rank. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + prices: + type: array + description: The update's prices. + items: + $ref: ./AdminCreateProductVariantPrice.yaml + options: + type: object + description: The update's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml new file mode 100644 index 0000000000..fb9b87db05 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml @@ -0,0 +1,22 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateSalesChannel +required: + - description + - metadata +properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml new file mode 100644 index 0000000000..79f40f4276 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -0,0 +1,63 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateStockLocation +required: + - address_id + - metadata +properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml new file mode 100644 index 0000000000..6a0aa16f40 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml @@ -0,0 +1,46 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateStore +required: + - name + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata +properties: + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + type: object + description: The supported currency's supported currencies. + required: + - currency_code + properties: + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml new file mode 100644 index 0000000000..67e66e7550 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -0,0 +1,47 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateTaxRate +required: + - metadata +properties: + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + rules: + type: array + description: The tax rate's rules. + items: + type: object + description: The rule's rules. + required: + - reference + - reference_id + properties: + reference: + type: string + title: reference + description: The rule's reference. + reference_id: + type: string + title: reference_id + description: The rule's reference id. + name: + type: string + title: name + description: The tax rate's name. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + metadata: + type: object + description: The tax rate's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUserRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml similarity index 85% rename from www/apps/api-reference/specs/store/components/schemas/AdminUpdateUserRequest.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index cf5247c937..781812e182 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUserRequest.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -1,7 +1,9 @@ type: object description: SUMMARY -x-schemaName: AdminUpdateUserRequest +x-schemaName: AdminUpdateUser required: + - first_name + - last_name - avatar_url properties: first_name: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml new file mode 100644 index 0000000000..8db01d8c4c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml @@ -0,0 +1,10 @@ +type: object +description: SUMMARY +x-schemaName: AdminUpdateVariantInventoryItem +required: + - required_quantity +properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/ApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/ApplicationMethod.yaml deleted file mode 100644 index 601d73f3a5..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/ApplicationMethod.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: ApplicationMethod -properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/ApplicationMethodsMethodPostReq.yaml b/www/apps/api-reference/specs/store/components/schemas/ApplicationMethodsMethodPostReq.yaml deleted file mode 100644 index d9798e4e3c..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/ApplicationMethodsMethodPostReq.yaml +++ /dev/null @@ -1,83 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: ApplicationMethodsMethodPostReq -properties: - description: - type: string - title: description - description: The application method's description. - value: - type: string - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - type: {} - target_type: {} - allocation: {} - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml new file mode 100644 index 0000000000..19efac7da2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml @@ -0,0 +1,3 @@ +type: object +description: The product's collection. +x-schemaName: BaseCollection diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml new file mode 100644 index 0000000000..97d46ce957 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml @@ -0,0 +1,3 @@ +type: object +description: The customer's customers. +x-schemaName: BaseCustomer diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml new file mode 100644 index 0000000000..b5f75c39e6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml @@ -0,0 +1,96 @@ +type: object +description: The address's addresses. +x-schemaName: BaseCustomerAddress +required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The address's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The address's is default billing. + customer_id: + type: string + title: customer_id + description: The address's customer id. + company: + type: string + title: company + description: The address's company. + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + phone: + type: string + title: phone + description: The address's phone. + metadata: + type: object + description: The address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml new file mode 100644 index 0000000000..5daa766350 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -0,0 +1,162 @@ +type: object +description: The updated's product. +x-schemaName: BaseProduct +required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - tags + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + $ref: ./BaseCollection.yaml + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + $ref: ./BaseProductCategory.yaml + type: + type: object + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: ./BaseProductTag.yaml + variants: + type: array + description: The product's variants. + items: + $ref: ./BaseProductVariant.yaml + options: + type: array + description: The product's options. + items: + $ref: ./BaseProductOption.yaml + images: + type: array + description: The product's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml new file mode 100644 index 0000000000..8bb7bdbaca --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml @@ -0,0 +1,3 @@ +type: object +description: The category's categories. +x-schemaName: BaseProductCategory diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml new file mode 100644 index 0000000000..cbabec4609 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml @@ -0,0 +1,3 @@ +type: object +description: The image's images. +x-schemaName: BaseProductImage diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml new file mode 100644 index 0000000000..91105a54c2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml @@ -0,0 +1,3 @@ +type: object +description: The option's options. +x-schemaName: BaseProductOption diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml new file mode 100644 index 0000000000..a607fba792 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The option's options. +x-schemaName: BaseProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The option's ID. + value: + type: string + title: value + description: The option's value. + option: + $ref: ./BaseProductOption.yaml + option_id: + type: string + title: option_id + description: The option's option id. + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml new file mode 100644 index 0000000000..eeff43fa01 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml @@ -0,0 +1,3 @@ +type: object +description: The tag's tags. +x-schemaName: BaseProductTag diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml new file mode 100644 index 0000000000..559318d70e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml @@ -0,0 +1,3 @@ +type: object +description: The variant's variants. +x-schemaName: BaseProductVariant diff --git a/www/apps/api-reference/specs/store/components/schemas/Campaign.yaml b/www/apps/api-reference/specs/store/components/schemas/Campaign.yaml deleted file mode 100644 index 4bb9a968c6..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/Campaign.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: The promotion's campaign. -x-schemaName: Campaign -properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CampaignBudget.yaml b/www/apps/api-reference/specs/store/components/schemas/CampaignBudget.yaml deleted file mode 100644 index cbd6c8f33d..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CampaignBudget.yaml +++ /dev/null @@ -1,9 +0,0 @@ -type: object -description: The campaign's budget. -x-schemaName: CampaignBudget -properties: - type: {} - limit: - type: number - title: limit - description: The budget's limit. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml index 93c6c488a6..5217a9aa3b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml @@ -49,4 +49,3 @@ properties: metadata: type: object description: The shipping address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateApplicationMethod.yaml deleted file mode 100644 index 72de305f09..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateApplicationMethod.yaml +++ /dev/null @@ -1,161 +0,0 @@ -type: object -description: The promotion's application method. -x-schemaName: CreateApplicationMethod -required: - - type - - target_type -properties: - type: - type: string - enum: - - fixed - - percentage - target_type: - type: string - enum: - - order - - shipping_methods - - items - allocation: - type: string - enum: - - each - - across - value: - type: number - title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - promotion: - oneOf: - - type: string - title: promotion - description: The application method's promotion. - - type: object - description: The application method's promotion. - x-schemaName: Promotion - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - code: - type: string - title: code - description: The promotion's code. - type: - type: string - enum: - - standard - - buyget - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - application_method: - $ref: ./ApplicationMethod.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - properties: {} - campaign: - $ref: ./Campaign.yaml - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCampaignBudget.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCampaignBudget.yaml deleted file mode 100644 index 4cb70d2da0..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCampaignBudget.yaml +++ /dev/null @@ -1,20 +0,0 @@ -type: object -description: The campaign's budget. -x-schemaName: CreateCampaignBudget -required: - - type - - limit -properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - used: - type: number - title: used - description: The budget's used. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml index 451a791dc5..ea5d127dd2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml @@ -45,4 +45,3 @@ properties: metadata: type: object description: The billing address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml index 6dad09e055..fc4ffc2354 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml @@ -6,7 +6,7 @@ required: - variant_id properties: quantity: - type: number + type: string title: quantity description: The item's quantity. variant_id: @@ -68,7 +68,6 @@ properties: variant_option_values: type: object description: The item's variant option values. - properties: {} requires_shipping: type: boolean title: requires_shipping @@ -86,18 +85,13 @@ properties: title: is_giftcard description: The item's is giftcard. compare_at_unit_price: - type: number + type: string title: compare_at_unit_price description: The item's compare at unit price. unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. + type: string + title: unit_price + description: The item's unit price. metadata: type: object description: The item's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml index 8739f0e9f8..369ef9b3a1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml @@ -36,218 +36,21 @@ properties: - type: string title: shipping_address description: The cart's shipping address. - - type: object - description: The cart's shipping address. - x-schemaName: CreateCartAddress - properties: - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - phone: - type: string - title: phone - description: The shipping address's phone. - company: - type: string - title: company - description: The shipping address's company. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - metadata: - type: object - description: The shipping address's metadata. - properties: {} + - $ref: ./CreateCartAddress.yaml billing_address: oneOf: - type: string title: billing_address description: The cart's billing address. - - type: object - description: The cart's billing address. - x-schemaName: CreateCartAddress - properties: - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - phone: - type: string - title: phone - description: The billing address's phone. - company: - type: string - title: company - description: The billing address's company. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - metadata: - type: object - description: The billing address's metadata. - properties: {} + - $ref: ./CreateCartAddress.yaml metadata: type: object description: The cart's metadata. - properties: {} items: type: array description: The cart's items. items: - type: object - description: The item's items. - x-schemaName: CreateCartCreateLineItem - required: - - quantity - - variant_id - properties: - quantity: - type: number - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant id. - title: - type: string - title: title - description: The item's title. - subtitle: - type: string - title: subtitle - description: The item's subtitle. - thumbnail: - type: string - title: thumbnail - description: The item's thumbnail. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - properties: {} - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - oneOf: - - type: string - title: unit_price - description: The item's unit price. - - type: number - title: unit_price - description: The item's unit price. - metadata: - type: object - description: The item's metadata. - properties: {} + $ref: ./CreateCartCreateLineItem.yaml promo_codes: type: array description: The cart's promo codes. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCustomer.yaml deleted file mode 100644 index 2d3dc8e709..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCustomer.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateCustomer -properties: - company_name: - type: string - title: company_name - description: The customer's company name. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - email: - type: string - title: email - description: The customer's email. - format: email - phone: - type: string - title: phone - description: The customer's phone. - created_by: - type: string - title: created_by - description: The customer's created by. - addresses: - type: array - description: The customer's addresses. - items: - type: object - description: The address's addresses. - x-schemaName: CreateCustomerAddress - properties: - address_name: - type: string - title: address_name - description: The address's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The address's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The address's is default billing. - company: - type: string - title: company - description: The address's company. - first_name: - type: string - title: first_name - description: The address's first name. - last_name: - type: string - title: last_name - description: The address's last name. - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - province: - type: string - title: province - description: The address's province. - postal_code: - type: string - title: postal_code - description: The address's postal code. - phone: - type: string - title: phone - description: The address's phone. - metadata: - type: object - description: The address's metadata. - properties: {} - metadata: - type: object - description: The customer's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateDefaultTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateDefaultTaxRate.yaml deleted file mode 100644 index c6c96103fd..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateDefaultTaxRate.yaml +++ /dev/null @@ -1,22 +0,0 @@ -type: object -description: The tax region's default tax rate. -x-schemaName: CreateDefaultTaxRate -required: - - name -properties: - rate: - type: number - title: rate - description: The default tax rate's rate. - code: - type: string - title: code - description: The default tax rate's code. - name: - type: string - title: name - description: The default tax rate's name. - metadata: - type: object - description: The default tax rate's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateInvite.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateInvite.yaml deleted file mode 100644 index 3bd337893f..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateInvite.yaml +++ /dev/null @@ -1,19 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateInvite -required: - - email -properties: - email: - type: string - title: email - description: The invite's email. - format: email - accepted: - type: boolean - title: accepted - description: The invite's accepted. - metadata: - type: object - description: The invite's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml new file mode 100644 index 0000000000..efbb641c2f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: CreateOrderReturnReason +required: + - value + - label +properties: + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProduct.yaml deleted file mode 100644 index 16abcfdd21..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProduct.yaml +++ /dev/null @@ -1,256 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProduct -required: - - title -properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - oneOf: - - type: array - description: The product's images. - items: - type: string - title: images - description: The image's images. - - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - id: - type: string - title: id - description: The image's ID. - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type: - $ref: ./CreateProductType.yaml - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - x-schemaName: CreateProductTag - required: - - value - properties: - value: - type: string - title: value - description: The tag's value. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductOption - required: - - title - properties: - title: - type: string - title: title - description: The option's title. - product_id: - type: string - title: product_id - description: The option's product id. - variants: - type: array - description: The product's variants. - items: - type: object - description: The variant's variants. - x-schemaName: CreateProductVariant - required: - - title - properties: - product_id: - type: string - title: product_id - description: The variant's product id. - title: - type: string - title: title - description: The variant's title. - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The variant's metadata. - properties: {} - width: - type: number - title: width - description: The product's width. - height: - type: number - title: height - description: The product's height. - length: - type: number - title: length - description: The product's length. - weight: - type: number - title: weight - description: The product's weight. - origin_country: - type: string - title: origin_country - description: The product's origin country. - hs_code: - type: string - title: hs_code - description: The product's hs code. - material: - type: string - title: material - description: The product's material. - mid_code: - type: string - title: mid_code - description: The product's mid code. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductOption.yaml deleted file mode 100644 index d0bdb74b07..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductOption.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProductOption -required: - - title -properties: - title: - type: string - title: title - description: The product's title. - product_id: - type: string - title: product_id - description: The product's product id. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductTag.yaml deleted file mode 100644 index e3f438c37b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductTag.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The tag's tags. -x-schemaName: CreateProductTag -required: - - value -properties: - value: - type: string - title: value - description: The tag's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductType.yaml deleted file mode 100644 index 9e0d11fe46..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductType.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: The product's type. -x-schemaName: CreateProductType -required: - - value -properties: - id: - type: string - title: id - description: The type's ID. - value: - type: string - title: value - description: The type's value. - metadata: - type: object - description: The type's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductVariant.yaml deleted file mode 100644 index 0ee0493162..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductVariant.yaml +++ /dev/null @@ -1,96 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateProductVariant -required: - - title -properties: - product_id: - type: string - title: product_id - description: The product's product id. - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - barcode: - type: string - title: barcode - description: The product's barcode. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The product's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - hs_code: - type: string - title: hs_code - description: The product's hs code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateProductVariantOption.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductVariantOption.yaml deleted file mode 100644 index 0e6a3cc9cd..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateProductVariantOption.yaml +++ /dev/null @@ -1,14 +0,0 @@ -type: object -description: The option's options. -x-schemaName: CreateProductVariantOption -required: - - value -properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreatePromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/CreatePromotion.yaml deleted file mode 100644 index a6682edf44..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreatePromotion.yaml +++ /dev/null @@ -1,69 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreatePromotion -required: - - code - - type -properties: - code: - type: string - title: code - description: The promotion's code. - type: - type: string - enum: - - standard - - buyget - is_automatic: - type: boolean - title: is_automatic - description: The promotion's is automatic. - application_method: - $ref: ./CreateApplicationMethod.yaml - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: CreatePromotionRule - required: - - attribute - - operator - - values - properties: - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - campaign: - $ref: ./CreateCampaign.yaml - campaign_id: - type: string - title: campaign_id - description: The promotion's campaign id. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreatePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/CreatePromotionRule.yaml deleted file mode 100644 index 71dece3435..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreatePromotionRule.yaml +++ /dev/null @@ -1,37 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: CreatePromotionRule -required: - - attribute - - operator - - values -properties: - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - operator: - type: string - enum: - - gt - - lt - - eq - - ne - - in - - lte - - gte - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateRegion.yaml deleted file mode 100644 index 7e4f392265..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateRegion.yaml +++ /dev/null @@ -1,26 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CreateRegion -required: - - name - - currency_code -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. - metadata: - type: object - description: The region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateTaxRateRule.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateTaxRateRule.yaml deleted file mode 100644 index ca8c3e1e3c..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateTaxRateRule.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: CreateTaxRateRule -required: - - reference - - reference_id -properties: - reference: - type: string - title: reference - description: The rule's reference. - reference_id: - type: string - title: reference_id - description: The rule's reference id. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml index 13ef7578ba..3dfd4dcddb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml @@ -24,4 +24,3 @@ properties: metadata: type: object description: The user's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerAddress.yaml deleted file mode 100644 index b27d2dfb61..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CustomerAddress.yaml +++ /dev/null @@ -1,76 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: CustomerAddress -properties: - id: - type: string - title: id - description: The customer's ID. - address_name: - type: string - title: address_name - description: The customer's address name. - is_default_shipping: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - is_default_billing: - type: boolean - title: is_default_billing - description: The customer's is default billing. - customer_id: - type: string - title: customer_id - description: The customer's customer id. - company: - type: string - title: company - description: The customer's company. - first_name: - type: string - title: first_name - description: The customer's first name. - last_name: - type: string - title: last_name - description: The customer's last name. - address_1: - type: string - title: address_1 - description: The customer's address 1. - address_2: - type: string - title: address_2 - description: The customer's address 2. - city: - type: string - title: city - description: The customer's city. - country_code: - type: string - title: country_code - description: The customer's country code. - province: - type: string - title: province - description: The customer's province. - postal_code: - type: string - title: postal_code - description: The customer's postal code. - phone: - type: string - title: phone - description: The customer's phone. - metadata: - type: object - description: The customer's metadata. - properties: {} - created_at: - type: string - title: created_at - description: The customer's created at. - updated_at: - type: string - title: updated_at - description: The customer's updated at. diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupsBatchCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupsBatchCustomer.yaml deleted file mode 100644 index 66fb19179a..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupsBatchCustomer.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The customer id's customer ids. -x-schemaName: CustomerGroupsBatchCustomer -required: - - id -properties: - id: - type: string - title: id - description: The customer id's ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/IdObject.yaml b/www/apps/api-reference/specs/store/components/schemas/IdObject.yaml deleted file mode 100644 index b7ccb55d49..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/IdObject.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The promotion's promotions. -x-schemaName: IdObject -required: - - id -properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/MultipleErrors.yaml b/www/apps/api-reference/specs/store/components/schemas/MultipleErrors.yaml deleted file mode 100644 index 7ca18cda3b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/MultipleErrors.yaml +++ /dev/null @@ -1,13 +0,0 @@ -title: Multiple Errors -type: object -properties: - errors: - type: array - description: Array of errors - items: - $ref: ./Error.yaml - message: - type: string - default: >- - Provided request body contains errors. Please check the data and retry the - request diff --git a/www/apps/api-reference/specs/store/components/schemas/Promotion.yaml b/www/apps/api-reference/specs/store/components/schemas/Promotion.yaml deleted file mode 100644 index 7efc28f3cc..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/Promotion.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: The promotion's promotions. -x-schemaName: Promotion -required: - - id -properties: - id: - type: string - title: id - description: The promotion's ID. diff --git a/www/apps/api-reference/specs/store/components/schemas/PromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/PromotionRule.yaml deleted file mode 100644 index b84cc3a668..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/PromotionRule.yaml +++ /dev/null @@ -1,33 +0,0 @@ -type: object -description: The rule's rules. -x-schemaName: PromotionRule -required: - - operator - - attribute - - values -properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationAddress.yaml deleted file mode 100644 index e5f134ac92..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddress.yaml +++ /dev/null @@ -1,39 +0,0 @@ -type: object -description: The stock location's address. -x-schemaName: StockLocationAddress -required: - - address_1 - - country_code -properties: - address_1: - type: string - title: address_1 - description: The address's address 1. - address_2: - type: string - title: address_2 - description: The address's address 2. - company: - type: string - title: company - description: The address's company. - city: - type: string - title: city - description: The address's city. - country_code: - type: string - title: country_code - description: The address's country code. - phone: - type: string - title: phone - description: The address's phone. - postal_code: - type: string - title: postal_code - description: The address's postal code. - province: - type: string - title: province - description: The address's province. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml new file mode 100644 index 0000000000..abf0714b02 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml @@ -0,0 +1,19 @@ +type: object +description: SUMMARY +x-schemaName: StoreAddCartLineItem +required: + - variant_id + - quantity + - metadata +properties: + variant_id: + type: string + title: variant_id + description: The cart's variant id. + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml new file mode 100644 index 0000000000..729f1b95bd --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreCalculateCartTaxes +properties: + fields: + type: string + title: fields + description: The cart's fields. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml new file mode 100644 index 0000000000..07e7bc885c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml @@ -0,0 +1,31 @@ +type: object +description: SUMMARY +x-schemaName: StoreCreateCustomer +required: + - email + - company_name + - first_name + - last_name + - phone +properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartTaxesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartTaxesReq.yaml deleted file mode 100644 index 11c9ef8037..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartTaxesReq.yaml +++ /dev/null @@ -1,4 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostCartsCartTaxesReq -properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml deleted file mode 100644 index 6163812d67..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml +++ /dev/null @@ -1,15 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StorePostPaymentCollectionsPaymentSessionReq -required: - - provider_id -properties: - provider_id: - type: string - title: provider_id - description: The payment collection's provider id. - context: {} - data: - type: object - description: The payment collection's data. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml new file mode 100644 index 0000000000..3ab63409b6 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReqSchema.yaml @@ -0,0 +1,68 @@ +type: object +description: SUMMARY +x-schemaName: StorePostReturnsReqSchema +required: + - order_id + - items + - return_shipping + - note + - location_id +properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml new file mode 100644 index 0000000000..73ed56e5b1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -0,0 +1,162 @@ +type: object +description: The product's products. +x-schemaName: StoreProduct +required: + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - variants + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id +properties: + categories: + type: array + description: The product's categories. + items: + type: object + type: + type: object + title: + type: string + title: title + description: The product's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The product's length. + options: + type: array + description: The product's options. + items: + $ref: ./BaseProductOption.yaml + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + handle: + type: string + title: handle + description: The product's handle. + metadata: + type: object + description: The product's metadata. + hs_code: + type: string + title: hs_code + description: The product's hs code. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + variants: + type: array + description: The product's variants. + items: + $ref: ./BaseProductVariant.yaml + subtitle: + type: string + title: subtitle + description: The product's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + collection: + $ref: ./BaseCollection.yaml + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: ./BaseProductTag.yaml + images: + type: array + description: The product's images. + items: + $ref: ./BaseProductImage.yaml + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml new file mode 100644 index 0000000000..5f98dcd652 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml @@ -0,0 +1,77 @@ +type: object +description: The product category's details. +x-schemaName: StoreProductCategory +required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at +properties: + products: + type: array + description: The product category's products. + items: + $ref: ./StoreProduct.yaml + id: + type: string + title: id + description: The product category's ID. + 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_active: + type: boolean + title: is_active + description: The product category's is active. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + rank: + type: number + title: rank + description: The product category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The product category's parent category id. + parent_category: + $ref: ./BaseProductCategory.yaml + category_children: + type: array + description: The product category's category children. + items: + $ref: ./BaseProductCategory.yaml + created_at: + type: string + format: date-time + title: created_at + description: The product category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product category's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml new file mode 100644 index 0000000000..0b9eedfe4f --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml @@ -0,0 +1,26 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductCategoryListResponse +required: + - limit + - offset + - count + - product_categories +properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml new file mode 100644 index 0000000000..05dc39f824 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml @@ -0,0 +1,8 @@ +type: object +description: SUMMARY +x-schemaName: StoreProductCategoryResponse +required: + - product_category +properties: + product_category: + $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml new file mode 100644 index 0000000000..e7c6862965 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml @@ -0,0 +1,14 @@ +type: object +description: SUMMARY +x-schemaName: StoreUpdateCartLineItem +required: + - quantity + - metadata +properties: + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml new file mode 100644 index 0000000000..f9c3b19ebb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml @@ -0,0 +1,25 @@ +type: object +description: SUMMARY +x-schemaName: StoreUpdateCustomer +required: + - company_name + - first_name + - last_name + - phone +properties: + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml index 13c364983d..0338cc6658 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml @@ -55,4 +55,3 @@ properties: metadata: type: object description: The shipping address's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml index 2165e1e45b..0b29d94268 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml @@ -33,229 +33,12 @@ properties: description: The cart's billing address id. billing_address: oneOf: - - type: object - description: The cart's billing address. - x-schemaName: CreateAddress - properties: - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - company: - type: string - title: company - description: The billing address's company. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - phone: - type: string - title: phone - description: The billing address's phone. - metadata: - type: object - description: The billing address's metadata. - properties: {} - - type: object - description: The cart's billing address. - x-schemaName: UpdateAddress - required: - - id - properties: - id: - type: string - title: id - description: The billing address's ID. - customer_id: - type: string - title: customer_id - description: The billing address's customer id. - company: - type: string - title: company - description: The billing address's company. - first_name: - type: string - title: first_name - description: The billing address's first name. - last_name: - type: string - title: last_name - description: The billing address's last name. - address_1: - type: string - title: address_1 - description: The billing address's address 1. - address_2: - type: string - title: address_2 - description: The billing address's address 2. - city: - type: string - title: city - description: The billing address's city. - country_code: - type: string - title: country_code - description: The billing address's country code. - province: - type: string - title: province - description: The billing address's province. - postal_code: - type: string - title: postal_code - description: The billing address's postal code. - phone: - type: string - title: phone - description: The billing address's phone. - metadata: - type: object - description: The billing address's metadata. - properties: {} + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml shipping_address: oneOf: - - type: object - description: The cart's shipping address. - x-schemaName: CreateAddress - properties: - customer_id: - type: string - title: customer_id - description: The shipping address's customer id. - company: - type: string - title: company - description: The shipping address's company. - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - phone: - type: string - title: phone - description: The shipping address's phone. - metadata: - type: object - description: The shipping address's metadata. - properties: {} - - type: object - description: The cart's shipping address. - x-schemaName: UpdateAddress - required: - - id - properties: - id: - type: string - title: id - description: The shipping address's ID. - customer_id: - type: string - title: customer_id - description: The shipping address's customer id. - company: - type: string - title: company - description: The shipping address's company. - first_name: - type: string - title: first_name - description: The shipping address's first name. - last_name: - type: string - title: last_name - description: The shipping address's last name. - address_1: - type: string - title: address_1 - description: The shipping address's address 1. - address_2: - type: string - title: address_2 - description: The shipping address's address 2. - city: - type: string - title: city - description: The shipping address's city. - country_code: - type: string - title: country_code - description: The shipping address's country code. - province: - type: string - title: province - description: The shipping address's province. - postal_code: - type: string - title: postal_code - description: The shipping address's postal code. - phone: - type: string - title: phone - description: The shipping address's phone. - metadata: - type: object - description: The shipping address's metadata. - properties: {} + - $ref: ./CreateAddress.yaml + - $ref: ./UpdateAddress.yaml metadata: type: object description: The cart's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml new file mode 100644 index 0000000000..581ad731dc --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml @@ -0,0 +1,23 @@ +type: object +description: SUMMARY +x-schemaName: UpdateOrderReturnReason +properties: + id: + type: string + title: id + description: The return reason's ID. + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProduct.yaml deleted file mode 100644 index d846bae03c..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateProduct.yaml +++ /dev/null @@ -1,271 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProduct -properties: - title: - type: string - title: title - description: The product's title. - subtitle: - type: string - title: subtitle - description: The product's subtitle. - description: - type: string - title: description - description: The product's description. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - discountable: - type: boolean - title: discountable - description: The product's discountable. - images: - oneOf: - - type: array - description: The product's images. - items: - type: string - title: images - description: The image's images. - - type: array - description: The product's images. - items: - type: object - description: The image's images. - required: - - url - properties: - id: - type: string - title: id - description: The image's ID. - url: - type: string - title: url - description: The image's url. - thumbnail: - type: string - title: thumbnail - description: The product's thumbnail. - handle: - type: string - title: handle - description: The product's handle. - status: - type: string - enum: - - draft - - proposed - - published - - rejected - type: - $ref: ./CreateProductType.yaml - type_id: - type: string - title: type_id - description: The product's type id. - collection_id: - type: string - title: collection_id - description: The product's collection id. - tags: - type: array - description: The product's tags. - items: - type: object - description: The tag's tags. - x-schemaName: CreateProductTag - required: - - value - properties: - value: - type: string - title: value - description: The tag's value. - categories: - type: array - description: The product's categories. - items: - type: object - description: The category's categories. - required: - - id - properties: - id: - type: string - title: id - description: The category's ID. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductOption - required: - - title - properties: - title: - type: string - title: title - description: The option's title. - product_id: - type: string - title: product_id - description: The option's product id. - variants: - type: array - description: The product's variants. - items: - type: object - description: The variant's variants. - x-schemaName: UpsertProductVariant - required: - - title - - metadata - - sku - - barcode - - ean - - upc - - allow_backorder - - inventory_quantity - - manage_inventory - - hs_code - - origin_country - - mid_code - - material - - weight - - length - - height - - width - - options - properties: - id: - type: string - title: id - description: The variant's ID. - title: - type: string - title: title - description: The variant's title. - metadata: - type: object - description: The variant's metadata. - properties: {} - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - width: - type: number - title: width - description: The product's width. - height: - type: number - title: height - description: The product's height. - length: - type: number - title: length - description: The product's length. - weight: - type: number - title: weight - description: The product's weight. - origin_country: - type: string - title: origin_country - description: The product's origin country. - hs_code: - type: string - title: hs_code - description: The product's hs code. - material: - type: string - title: material - description: The product's material. - mid_code: - type: string - title: mid_code - description: The product's mid code. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductCollection.yaml deleted file mode 100644 index 603135d317..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateProductCollection.yaml +++ /dev/null @@ -1,27 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductCollection -properties: - value: - type: string - title: value - description: The collection's value. - title: - type: string - title: title - description: The collection's title. - handle: - type: string - title: handle - description: The collection's handle. - product_ids: - type: array - description: The collection's product ids. - items: - type: string - title: product_ids - description: The product id's product ids. - metadata: - type: object - description: The collection's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductOption.yaml deleted file mode 100644 index b01b1af91b..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateProductOption.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductOption -required: - - id -properties: - id: - type: string - title: id - description: The product's ID. - title: - type: string - title: title - description: The product's title. - product_id: - type: string - title: product_id - description: The product's product id. diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductVariant.yaml deleted file mode 100644 index 23eba47ad6..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateProductVariant.yaml +++ /dev/null @@ -1,96 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateProductVariant -required: - - id -properties: - id: - type: string - title: id - description: The product's ID. - title: - type: string - title: title - description: The product's title. - sku: - type: string - title: sku - description: The product's sku. - barcode: - type: string - title: barcode - description: The product's barcode. - ean: - type: string - title: ean - description: The product's ean. - upc: - type: string - title: upc - description: The product's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The product's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - hs_code: - type: string - title: hs_code - description: The product's hs code. - origin_country: - type: string - title: origin_country - description: The product's origin country. - mid_code: - type: string - title: mid_code - description: The product's mid code. - material: - type: string - title: material - description: The product's material. - weight: - type: number - title: weight - description: The product's weight. - length: - type: number - title: length - description: The product's length. - height: - type: number - title: height - description: The product's height. - width: - type: number - title: width - description: The product's width. - options: - type: array - description: The product's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. - metadata: - type: object - description: The product's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateRegion.yaml deleted file mode 100644 index 73c97adabc..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateRegion.yaml +++ /dev/null @@ -1,23 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: UpdateRegion -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. - metadata: - type: object - description: The region's metadata. - properties: {} diff --git a/www/apps/api-reference/specs/store/components/schemas/UpsertProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/UpsertProductVariant.yaml deleted file mode 100644 index 53dbabc509..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/UpsertProductVariant.yaml +++ /dev/null @@ -1,113 +0,0 @@ -type: object -description: The variant's variants. -x-schemaName: UpsertProductVariant -required: - - title - - metadata - - sku - - barcode - - ean - - upc - - allow_backorder - - inventory_quantity - - manage_inventory - - hs_code - - origin_country - - mid_code - - material - - weight - - length - - height - - width - - options -properties: - id: - type: string - title: id - description: The variant's ID. - title: - type: string - title: title - description: The variant's title. - metadata: - type: object - description: The variant's metadata. - properties: {} - sku: - type: string - title: sku - description: The variant's sku. - barcode: - type: string - title: barcode - description: The variant's barcode. - ean: - type: string - title: ean - description: The variant's ean. - upc: - type: string - title: upc - description: The variant's upc. - allow_backorder: - type: boolean - title: allow_backorder - description: The variant's allow backorder. - inventory_quantity: - type: number - title: inventory_quantity - description: The variant's inventory quantity. - manage_inventory: - type: boolean - title: manage_inventory - description: The variant's manage inventory. - hs_code: - type: string - title: hs_code - description: The variant's hs code. - origin_country: - type: string - title: origin_country - description: The variant's origin country. - mid_code: - type: string - title: mid_code - description: The variant's mid code. - material: - type: string - title: material - description: The variant's material. - weight: - type: number - title: weight - description: The variant's weight. - length: - type: number - title: length - description: The variant's length. - height: - type: number - title: height - description: The variant's height. - width: - type: number - title: width - description: The variant's width. - options: - type: array - description: The variant's options. - items: - type: object - description: The option's options. - x-schemaName: CreateProductVariantOption - required: - - value - properties: - value: - type: string - title: value - description: The option's value. - option_id: - type: string - title: option_id - description: The option's option id. diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index fe076c90a1..2e604bb470 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -16,16 +16,20 @@ tags: externalDocs: description: How to implement cart functionality in your storefront url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + - name: Collections - name: Currencies - name: Customers - description: | - A customer can register and manage their information such as addresses, orders, payment methods, and more. - externalDocs: - description: How to implement customer profiles in your storefront - url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles + - name: Orders - name: Payment Collections description: | A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Payment Providers + - name: Product Categories + x-associatedSchema: + $ref: '#/components/schemas/StoreProductCategory' + - name: Products + x-associatedSchema: + $ref: '#/components/schemas/StoreProduct' - name: Regions description: | Regions are different countries or geographical regions that the commerce store serves customers in. @@ -33,12 +37,9 @@ tags: externalDocs: description: How to use regions in a storefront url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + - name: Return + - name: Return Reasons - name: Shipping Options - description: | - A shipping option is used to define the available shipping methods during checkout or when creating a return. - externalDocs: - description: Shipping Option architecture - url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option paths: /store/carts: post: @@ -46,7 +47,58 @@ paths: summary: Create Cart description: Create a cart. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateCartWorkflowInput' x-codeSamples: - lang: Shell label: cURL @@ -54,6 +106,8 @@ paths: tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -66,10 +120,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/carts/{id}: get: operationId: GetCartsId @@ -83,6 +133,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -90,6 +186,8 @@ paths: tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -102,10 +200,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCartsId summary: Update a Cart @@ -118,6 +212,57 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpdateCartData' x-codeSamples: - lang: Shell label: cURL @@ -125,6 +270,8 @@ paths: tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -137,10 +284,97 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/carts/{id}/complete: + post: + operationId: PostCartsIdComplete + summary: Add Completes to Cart + description: Add a list of completes to a cart. + x-authenticated: false + parameters: + - name: id + in: path + description: The cart's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + properties: + idempotency_key: + type: string + title: idempotency_key + description: The cart's idempotency key. + x-codeSamples: + - lang: Shell + label: cURL + source: curl -X POST '{backend_url}/store/carts/{id}/complete' + tags: + - Carts + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /store/carts/{id}/line-items: post: operationId: PostCartsIdLineItems @@ -154,13 +388,73 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreAddCartLineItem' x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/line-items' + source: |- + curl -X POST '{backend_url}/store/carts/{id}/line-items' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "variant_id": "{value}", + "quantity": 3360689747918848, + "metadata": {} + }' tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -173,10 +467,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/carts/{id}/line-items/{line_id}: post: operationId: PostCartsIdLineItemsLine_id @@ -196,13 +486,72 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreUpdateCartLineItem' x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' + source: |- + curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "quantity": 8980402259623936, + "metadata": {} + }' tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -215,10 +564,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Items from Cart @@ -237,6 +582,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -244,6 +635,33 @@ paths: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The cart's ID. + object: + type: string + title: object + description: The cart's object. + deleted: + type: boolean + title: deleted + description: The cart's deleted. + parent: + type: object + description: The cart's parent. '400': $ref: '#/components/responses/400_error' '401': @@ -256,46 +674,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /store/carts/{id}/payment-collections: - post: - operationId: PostCartsIdPaymentCollections - summary: Add Payment Collections to Cart - description: Add a list of payment collections to a cart. - x-authenticated: false - parameters: - - name: id - in: path - description: The cart's ID. - required: true - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/payment-collections' - tags: - - Carts - responses: - '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' - requestBody: - content: - application/json: - schema: {} /store/carts/{id}/promotions: post: operationId: PostCartsIdPromotions @@ -309,13 +687,84 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - promo_codes + properties: + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/carts/{id}/promotions' + source: |- + curl -X POST '{backend_url}/store/carts/{id}/promotions' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "promo_codes": [ + "{value}" + ] + }' tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -328,10 +777,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -344,6 +789,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -351,6 +842,8 @@ paths: tags: - Carts responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -363,10 +856,107 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/carts/{id}/shipping-methods: + post: + operationId: PostCartsIdShippingMethods + summary: Add Shipping Methods to Cart + description: Add a list of shipping methods to a cart. + x-authenticated: false + parameters: + - name: id + in: path + description: The cart's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The cart's option id. + data: + type: object + description: The cart's data. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "option_id": "{value}" + }' + tags: + - Carts + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /store/carts/{id}/taxes: post: operationId: PostCartsIdTaxes @@ -380,11 +970,57 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: schema: - $ref: '#/components/schemas/StorePostCartsCartTaxesReq' + $ref: '#/components/schemas/StoreCalculateCartTaxes' x-codeSamples: - lang: Shell label: cURL @@ -392,6 +1028,162 @@ paths: tags: - Carts responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/collections: + get: + operationId: GetCollections + summary: List Collections + description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/collections' + tags: + - Collections + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/collections/{id}: + get: + 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. + x-authenticated: false + parameters: + - name: id + in: path + description: The collection's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/collections/{id}' + tags: + - Collections + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -410,7 +1202,53 @@ paths: summary: List Currencies description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -418,6 +1256,8 @@ paths: tags: - Currencies responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -430,10 +1270,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/currencies/{code}: get: operationId: GetCurrenciesCode @@ -447,6 +1283,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -454,6 +1336,8 @@ paths: tags: - Currencies responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -466,24 +1350,82 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/customers: post: operationId: PostCustomers summary: Create Customer description: Create a customer. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StoreCreateCustomer' x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/customers' + source: |- + curl -X POST '{backend_url}/store/customers' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "email": "Monserrate.Leannon88@yahoo.com", + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}" + }' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -496,24 +1438,73 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/customers/me: get: operationId: GetCustomersMe summary: List Customers description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/customers/me' + source: |- + curl '{backend_url}/store/customers/me' \ + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -526,24 +1517,274 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + post: + operationId: PostCustomersMe + summary: Create Customer + description: Create a customer. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: '#/components/schemas/StoreUpdateCustomer' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/store/customers/me' \ + -H 'Authorization: Bearer {access_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "company_name": "{value}", + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}" + }' + tags: + - Customers + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /store/customers/me/addresses: get: operationId: GetCustomersMeAddresses summary: List Customers description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: metadata + in: query + description: The customer's metadata. + required: true + schema: + type: object + description: The customer's metadata. + - name: first_name + in: query + description: The customer's first name. + required: true + schema: + type: string + title: first_name + description: The customer's first name. + - name: last_name + in: query + description: The customer's last name. + required: true + schema: + type: string + title: last_name + description: The customer's last name. + - name: phone + in: query + description: The customer's phone. + required: true + schema: + type: string + title: phone + description: The customer's phone. + - name: company + in: query + description: The customer's company. + required: true + schema: + type: string + title: company + description: The customer's company. + - name: address_1 + in: query + description: The customer's address 1. + required: true + schema: + type: string + title: address_1 + description: The customer's address 1. + - name: address_2 + in: query + description: The customer's address 2. + required: true + schema: + type: string + title: address_2 + description: The customer's address 2. + - name: city + in: query + description: The customer's city. + required: true + schema: + type: string + title: city + description: The customer's city. + - name: country_code + in: query + description: The customer's country code. + required: true + schema: + type: string + title: country_code + description: The customer's country code. + - name: province + in: query + description: The customer's province. + required: true + schema: + type: string + title: province + description: The customer's province. + - name: postal_code + in: query + description: The customer's postal code. + required: true + schema: + type: string + title: postal_code + description: The customer's postal code. + - name: address_name + in: query + description: The customer's address name. + required: true + schema: + type: string + title: address_name + description: The customer's address name. + - name: is_default_shipping + in: query + description: The customer's is default shipping. + required: false + schema: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + - name: is_default_billing + in: query + description: The customer's is default billing. + required: false + schema: + type: boolean + title: is_default_billing + description: The customer's is default billing. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/customers/me/addresses' + source: |- + curl '{backend_url}/store/customers/me/addresses' \ + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -556,23 +1797,162 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersMeAddresses summary: Create Customer description: Create a customer. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - address_name + properties: + metadata: + type: object + description: The customer's metadata. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + company: + type: string + title: company + description: The customer's company. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/customers/me/addresses' + source: |- + curl -X POST '{backend_url}/store/customers/me/addresses' \ + -H 'Authorization: Bearer {access_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {}, + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "address_name": "{value}" + }' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -585,16 +1965,12 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/customers/me/addresses/{address_id}: get: operationId: GetCustomersMeAddressesAddress_id summary: List Addresses description: Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -602,13 +1978,66 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/customers/me/addresses/{address_id}' + source: |- + curl '{backend_url}/store/customers/me/addresses/{address_id}' \ + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -621,15 +2050,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersMeAddressesAddress_id summary: Add Addresses to Customer description: Add a list of addresses to a customer. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -637,13 +2062,156 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - address_name + properties: + metadata: + type: object + description: The customer's metadata. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + company: + type: string + title: company + description: The customer's company. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. x-codeSamples: - lang: Shell label: cURL - source: curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' + source: |- + curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ + -H 'Authorization: Bearer {access_token}' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "metadata": {}, + "first_name": "{value}", + "last_name": "{value}", + "phone": "{value}", + "company": "{value}", + "address_1": "{value}", + "address_2": "{value}", + "city": "{value}", + "country_code": "{value}", + "province": "{value}", + "postal_code": "{value}", + "address_name": "{value}" + }' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -656,15 +2224,11 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Addresses from Customer description: Remove a list of addresses from a customer. This doesn't delete the Address, only the association between the Address and the customer. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -672,13 +2236,66 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL - source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' + source: |- + curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ + -H 'Authorization: Bearer {access_token}' tags: - Customers responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -691,10 +2308,342 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/orders: + get: + operationId: GetOrders + summary: List Orders + description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - 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: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The order's name. + - type: array + description: The order's name. + items: + type: string + title: name + description: The name's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/orders' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/orders/{id}: + get: + operationId: GetOrdersId + summary: Get a Order + description: Retrieve a order by its ID. You can expand the order's relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - 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: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/orders/{id}' + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/payment-collections: + post: + operationId: PostPaymentCollections + summary: Create Payment Collection + description: Create a payment collection. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: - schema: {} + schema: + type: object + description: SUMMARY + required: + - cart_id + - region_id + - currency_code + - amount + properties: + cart_id: + type: string + title: cart_id + description: The payment collection's cart id. + region_id: + type: string + title: region_id + description: The payment collection's region id. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + amount: + type: number + title: amount + description: The payment collection's amount. + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/store/payment-collections' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "cart_id": "{value}", + "region_id": "{value}", + "currency_code": "{value}", + "amount": 8468325826822144 + }' + tags: + - Payment Collections + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /store/payment-collections/{id}/payment-sessions: post: operationId: PostPaymentCollectionsIdPaymentSessions @@ -708,11 +2657,71 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: schema: - $ref: '#/components/schemas/StorePostPaymentCollectionsPaymentSessionReq' + type: object + description: SUMMARY + required: + - provider_id + properties: + provider_id: + type: string + title: provider_id + description: The payment collection's provider id. + context: + type: object + description: The payment collection's context. + data: + type: object + description: The payment collection's data. x-codeSamples: - lang: Shell label: cURL @@ -725,6 +2734,1157 @@ paths: tags: - Payment Collections responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/payment-providers: + get: + operationId: GetPaymentProviders + summary: List Payment Providers + description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: region_id + in: query + description: The payment provider's region id. + required: true + schema: + type: string + title: region_id + description: The payment provider's region id. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment provider's ID. + - type: array + description: The payment provider's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The payment provider's is enabled. + required: false + schema: + type: boolean + title: is_enabled + description: The payment provider's is enabled. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/payment-providers' + tags: + - Payment Providers + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/product-categories: + get: + operationId: GetProductCategories + summary: List Product Categories + description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: q + in: query + description: The product category's q. + required: false + schema: + type: string + title: q + description: The product category's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product category's ID. + - type: array + description: The product category's ID. + items: + type: string + title: id + description: The id's ID. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The product category's description. + - type: array + description: The product category's description. + items: + type: string + title: description + description: The description's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product category's handle. + - type: array + description: The product category's handle. + items: + type: string + title: handle + description: The handle's details. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: The product category's parent category id. + - type: array + description: The product category's parent category id. + items: + type: string + title: parent_category_id + description: The parent category id's details. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + - name: created_at + in: query + description: The product category's created at. + required: false + schema: + type: object + description: The product category's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product category's updated at. + required: false + schema: + type: object + description: The product category's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product category's deleted at. + required: false + schema: + type: object + description: The product category's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/product-categories' + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreProductCategoryListResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/product-categories/{id}: + get: + operationId: GetProductCategoriesId + summary: Get a Product Category + description: Retrieve a product category by its ID. You can expand the product category's relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/product-categories/{id}' + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StoreProductCategoryResponse' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/products: + get: + operationId: GetProducts + summary: List Products + description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + - name: variants + in: query + description: The product's variants. + required: false + schema: + type: object + description: The product's variants. + properties: + status: + type: array + description: The variant's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + options: + type: object + description: The variant's options. + required: + - value + - option_id + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's option id. + $and: {} + $or: {} + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + description: The product's title. + required: true + schema: + type: string + title: title + description: The product's title. + - name: handle + in: query + description: The product's handle. + required: true + schema: + type: string + title: handle + description: The product's handle. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: true + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: category_id + in: query + description: The product's category id. + required: true + schema: + type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - name: sales_channel_id + in: query + description: The product's sales channel id. + required: true + schema: + type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: collection_id + in: query + description: The product's collection id. + required: true + schema: + type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: array + description: The product's tags. + items: + type: string + title: tags + description: The tag's tags. + - name: type_id + in: query + description: The product's type id. + required: false + schema: + type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/products' + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/products/{id}: + get: + operationId: GetProductsId + summary: Get a Product + description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + - name: variants + in: query + description: The product's variants. + required: false + schema: + type: object + description: The product's variants. + properties: + status: + type: array + description: The variant's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + options: + type: object + description: The variant's options. + required: + - value + - option_id + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's option id. + $and: {} + $or: {} + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + description: The product's title. + required: true + schema: + type: string + title: title + description: The product's title. + - name: handle + in: query + description: The product's handle. + required: true + schema: + type: string + title: handle + description: The product's handle. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: true + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: category_id + in: query + description: The product's category id. + required: true + schema: + type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - name: sales_channel_id + in: query + description: The product's sales channel id. + required: true + schema: + type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: collection_id + in: query + description: The product's collection id. + required: true + schema: + type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: array + description: The product's tags. + items: + type: string + title: tags + description: The tag's tags. + - name: type_id + in: query + description: The product's type id. + required: false + schema: + type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/products/{id}' + tags: + - Products + responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -743,7 +3903,53 @@ paths: summary: List Regions description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -751,6 +3957,8 @@ paths: tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -763,10 +3971,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /store/regions/{id}: get: operationId: GetRegionsId @@ -780,6 +3984,52 @@ paths: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -787,6 +4037,8 @@ paths: tags: - Regions responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -799,30 +4051,246 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + /store/return: + post: + operationId: PostReturn + summary: Create Return + description: Create a return. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: - schema: {} - /store/regions/{id}/payment-providers: + schema: + $ref: '#/components/schemas/StorePostReturnsReqSchema' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/store/return' \ + -H 'Content-Type: application/json' \ + --data-raw '{ + "order_id": "{value}", + "items": [ + { + "id": "id_XbfptxUVo2io9EI", + "quantity": 7916429753974784, + "reason_id": "{value}", + "note": "{value}" + } + ], + "return_shipping": { + "option_id": "{value}", + "price": 1068364080349184 + }, + "note": "{value}", + "location_id": "{value}" + }' + tags: + - Return + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/return-reasons: get: - operationId: GetRegionsIdPaymentProviders - summary: List Payment Providers - description: Retrieve a list of payment providers in a region. The payment providers can be filtered by fields like FILTER FIELDS. The payment providers can also be paginated. + operationId: GetReturnReasons + summary: List Return Reasons + description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: curl '{backend_url}/store/return-reasons' + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' + /store/return-reasons/{id}: + get: + operationId: GetReturnReasonsId + summary: Get a Return Reason + description: Retrieve a return reason by its ID. You can expand the return reason's relations or select the fields that should be returned. x-authenticated: false parameters: - name: id in: path - description: The region's ID. + description: The return reason's ID. required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/regions/{id}/payment-providers' + source: curl '{backend_url}/store/return-reasons/{id}' tags: - - Regions + - Return Reasons responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -835,30 +4303,68 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} - /store/shipping-options/{cart_id}: + /store/shipping-options: get: - operationId: GetShippingOptionsCart_id - summary: Get a Shipping Option - description: Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned. + operationId: GetShippingOptions + summary: List Shipping Options + description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. x-authenticated: false parameters: - - name: cart_id - in: path - description: The shipping option's cart id. - required: true + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false schema: type: string + title: expand + description: Comma-separated relations that should be expanded in the returned data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL - source: curl '{backend_url}/store/shipping-options/{cart_id}' + source: curl '{backend_url}/store/shipping-options' tags: - Shipping Options responses: + '200': + description: OK '400': $ref: '#/components/responses/400_error' '401': @@ -871,10 +4377,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} components: responses: default_error: @@ -917,20 +4419,16 @@ components: message: Entity with id 1 was not found type: not_found 400_error: - description: Client Error or Multiple Errors + description: Client Error content: application/json: schema: - oneOf: - - $ref: '#/components/schemas/Error' - - $ref: '#/components/schemas/MultipleErrors' + $ref: '#/components/schemas/Error' examples: not_allowed: $ref: '#/components/examples/not_allowed_error' invalid_data: $ref: '#/components/examples/invalid_data_error' - MultipleErrors: - $ref: '#/components/examples/multiple_errors' 500_error: description: Server Error content: @@ -1049,1282 +4547,554 @@ components: Where `{sid}` is the value of `connect.sid` that you copied. schemas: - AdminDeletePricingRuleTypesRuleTypeReq: + AdminArchiveOrder: type: object description: SUMMARY - x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq - properties: {} - AdminGetPricingRuleTypesParams: - type: object - description: SUMMARY - x-schemaName: AdminGetPricingRuleTypesParams + x-schemaName: AdminArchiveOrder + required: + - order_id properties: - rule_attribute: + order_id: + type: string + title: order_id + description: The order's order id. + AdminBatchProductRequest: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductRequest + properties: + create: type: array - description: The pricing's rule attribute. + description: The product's create. + items: + $ref: '#/components/schemas/AdminCreateProduct' + update: + type: array + description: The product's update. + items: + $ref: '#/components/schemas/AdminUpdateProduct' + delete: + type: array + description: The product's delete. items: type: string - title: rule_attribute - description: The rule attribute's details. - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - offset: - type: number - title: offset - description: The pricing's offset. - limit: - type: number - title: limit - description: The pricing's limit. - order: - type: string - title: order - description: The pricing's order. - AdminGetPricingRuleTypesRuleTypeParams: + title: delete + description: The delete's details. + AdminBatchProductResponse: type: object description: SUMMARY - x-schemaName: AdminGetPricingRuleTypesRuleTypeParams + x-schemaName: AdminBatchProductResponse + required: + - created + - updated + - deleted properties: - expand: - type: string - title: expand - description: The pricing's expand. - fields: - type: string - title: fields - description: The pricing's fields. - AdminGetProductsParams: - type: object - description: SUMMARY - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. + created: + type: array + description: The product's created. + items: + $ref: '#/components/schemas/AdminProduct' + updated: + type: array + description: The product's updated. + items: + $ref: '#/components/schemas/AdminProduct' + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. items: type: string - title: id - description: The id's ID. - status: + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminBatchProductVariantRequest: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductVariantRequest + properties: + create: type: array - description: The product's status. - items: {} + description: The product's create. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + update: + type: array + description: The product's update. + items: + $ref: '#/components/schemas/AdminUpdateProductVariant' + delete: + type: array + description: The product's delete. + items: + type: string + title: delete + description: The delete's details. + AdminBatchProductVariantResponse: + type: object + description: SUMMARY + x-schemaName: AdminBatchProductVariantResponse + required: + - created + - updated + - deleted + properties: + created: + type: array + description: The product's created. + items: + $ref: '#/components/schemas/AdminProductVariant' + updated: + type: array + description: The product's updated. + items: + $ref: '#/components/schemas/AdminProductVariant' + deleted: + type: object + description: The product's deleted. + required: + - ids + - object + - deleted + properties: + ids: + type: array + description: The deleted's ids. + items: + type: string + title: ids + description: The id's ids. + object: + type: string + title: object + description: The deleted's object. + deleted: + type: boolean + title: deleted + description: The deleted's details. + AdminCancelFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminCancelFulfillment + AdminCollection: + type: object + description: The parent's collection. + x-schemaName: AdminCollection + properties: + id: + type: string + title: id + description: The collection's ID. title: type: string title: title - description: The product's title. + description: The collection's title. handle: type: string title: handle - description: The product's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The product's is giftcard. - price_list_id: + description: The collection's handle. + created_at: + type: string + format: date-time + title: created_at + description: The collection's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deleted at. + products: type: array - description: The product's price list id. + description: The collection's products. items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The product's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The product's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The product's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: + type: object + metadata: type: object - description: The product's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The product's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The product's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $and's q. - id: - oneOf: - - type: string - title: id - description: The $and's ID. - - type: array - description: The $and's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $and's status. - items: {} - title: - type: string - title: title - description: The $and's title. - handle: - type: string - title: handle - description: The $and's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $and's is giftcard. - price_list_id: - type: array - description: The $and's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $and's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $and's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $and's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $and's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $and's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $and's details. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $and's $or. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $and's expand. - fields: - type: string - title: fields - description: The $and's fields. - offset: - type: number - title: offset - description: The $and's offset. - limit: - type: number - title: limit - description: The $and's limit. - order: - type: string - title: order - description: The $and's order. - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: - q: - type: string - title: q - description: The $or's q. - id: - oneOf: - - type: string - title: id - description: The $or's ID. - - type: array - description: The $or's ID. - items: - type: string - title: id - description: The id's ID. - status: - type: array - description: The $or's status. - items: {} - title: - type: string - title: title - description: The $or's title. - handle: - type: string - title: handle - description: The $or's handle. - is_giftcard: - type: boolean - title: is_giftcard - description: The $or's is giftcard. - price_list_id: - type: array - description: The $or's price list id. - items: - type: string - title: price_list_id - description: The price list id's details. - sales_channel_id: - type: array - description: The $or's sales channel id. - items: - type: string - title: sales_channel_id - description: The sales channel id's details. - collection_id: - type: array - description: The $or's collection id. - items: - type: string - title: collection_id - description: The collection id's details. - tags: - type: array - description: The $or's tags. - items: - type: string - title: tags - description: The tag's tags. - type_id: - type: array - description: The $or's type id. - items: - type: string - title: type_id - description: The type id's details. - variants: - type: object - description: The $or's variants. - properties: {} - created_at: {} - updated_at: {} - deleted_at: {} - $and: - type: array - description: The $or's $and. - items: - type: object - description: The $and's details. - x-schemaName: AdminGetProductsParams - properties: {} - $or: - type: array - description: The $or's details. - items: - type: object - description: The $or's details. - x-schemaName: AdminGetProductsParams - properties: {} - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The $or's expand. - fields: - type: string - title: fields - description: The $or's fields. - offset: - type: number - title: offset - description: The $or's offset. - limit: - type: number - title: limit - description: The $or's limit. - order: - type: string - title: order - description: The $or's order. - expand: - type: string - title: expand - description: The product's expand. - fields: - type: string - title: fields - description: The product's fields. - offset: - type: number - title: offset - description: The product's offset. - limit: - type: number - title: limit - description: The product's limit. - order: - type: string - title: order - description: The product's order. - AdminGetPromotionsParams: + description: The collection's metadata. + AdminCompleteOrder: type: object description: SUMMARY - x-schemaName: AdminGetPromotionsParams + x-schemaName: AdminCompleteOrder + required: + - order_id properties: - code: + order_id: type: string - title: code - description: The promotion's code. - expand: - type: string - title: expand - description: The promotion's expand. - fields: - type: string - title: fields - description: The promotion's fields. - offset: - type: number - title: offset - description: The promotion's offset. - limit: - type: number - title: limit - description: The promotion's limit. - order: - type: string - title: order - description: The promotion's order. - AdminPostCampaignsReq: + title: order_id + description: The order's order id. + AdminCreateApiKey: type: object - description: The promotion's campaign. - x-schemaName: AdminPostCampaignsReq + description: SUMMARY + x-schemaName: AdminCreateApiKey + required: + - title + - type + properties: + title: + type: string + title: title + description: The api key's title. + type: + type: string + enum: + - publishable + - secret + AdminCreateCollection: + type: object + description: SUMMARY + x-schemaName: AdminCreateCollection + required: + - title + - metadata + properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. + AdminCreateCustomer: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminCreateCustomerAddress: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomerAddress + required: + - address_name + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + properties: + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. + company: + type: string + title: company + description: The customer's company. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminCreateCustomerGroup: + type: object + description: SUMMARY + x-schemaName: AdminCreateCustomerGroup required: - name + - metadata properties: name: type: string title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - currency: - type: string - title: currency - description: The campaign's currency. - budget: - $ref: '#/components/schemas/CampaignBudget' - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - x-schemaName: IdObject - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. - AdminPostCustomerGroupsGroupCustomersBatchReq: + description: The customer group's name. + metadata: + type: object + description: The customer group's metadata. + AdminCreateFulfillment: type: object description: SUMMARY - x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq - required: - - customer_ids - properties: - customer_ids: - type: array - description: The customer group's customer ids. - items: - type: object - description: The customer id's customer ids. - x-schemaName: CustomerGroupsBatchCustomer - required: - - id - properties: - id: - type: string - title: id - description: The customer id's ID. - AdminPostFulfillmentShippingOptionsRulesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq - required: - - rules - properties: - rules: - type: array - description: The fulfillment's rules. - items: - type: object - description: The rule's rules. - x-schemaName: FulfillmentRuleCreate - required: - - operator - - attribute - - value - properties: - operator: {} - 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. - AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq - required: - - rule_ids - properties: - rule_ids: - type: array - description: The fulfillment's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. - AdminPostInventoryItemsInventoryItemReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsInventoryItemReq - properties: - sku: - type: string - title: sku - description: The inventory item's sku. - origin_country: - type: string - title: origin_country - description: The inventory item's origin country. - hs_code: - type: string - title: hs_code - description: The inventory item's hs code. - 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. - weight: - type: number - title: weight - description: The inventory item's weight. - height: - type: number - title: height - description: The inventory item's height. - length: - type: number - title: length - description: The inventory item's length. - width: - type: number - title: width - description: The inventory item's width. - title: - type: string - title: title - description: The inventory item's title. - description: - type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. - requires_shipping: - type: boolean - title: requires_shipping - description: The inventory item's requires shipping. - AdminPostInventoryItemsItemLocationLevelsLevelReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq - properties: - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - AdminPostInventoryItemsItemLocationLevelsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq + x-schemaName: AdminCreateFulfillment required: - location_id - - stocked_quantity + - provider_id + - delivery_address + - items + - labels + - order + - order_id + - shipping_option_id + - data + - packed_at + - shipped_at + - delivered_at + - canceled_at + - metadata properties: location_id: type: string title: location_id - description: The inventory item's location id. - stocked_quantity: - type: number - title: stocked_quantity - description: The inventory item's stocked quantity. - incoming_quantity: - type: number - title: incoming_quantity - description: The inventory item's incoming quantity. - AdminPostInventoryItemsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostInventoryItemsReq - properties: - sku: + description: The fulfillment's location id. + provider_id: type: string - title: sku - description: The inventory item's sku. - hs_code: + title: provider_id + description: The fulfillment's provider id. + delivery_address: + type: object + description: The fulfillment's delivery address. + required: + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - metadata + properties: + first_name: + type: string + title: first_name + description: The delivery address's first name. + last_name: + type: string + title: last_name + description: The delivery address's last name. + phone: + type: string + title: phone + description: The delivery address's phone. + company: + type: string + title: company + description: The delivery address's company. + address_1: + type: string + title: address_1 + description: The delivery address's address 1. + address_2: + type: string + title: address_2 + description: The delivery address's address 2. + city: + type: string + title: city + description: The delivery address's city. + country_code: + type: string + title: country_code + description: The delivery address's country code. + province: + type: string + title: province + description: The delivery address's province. + postal_code: + type: string + title: postal_code + description: The delivery address's postal code. + metadata: + type: object + description: The delivery address's metadata. + items: + type: array + description: The fulfillment's items. + items: + type: object + description: The item's items. + required: + - title + - sku + - quantity + - barcode + - line_item_id + - inventory_item_id + properties: + title: + type: string + title: title + description: The item's title. + sku: + type: string + title: sku + description: The item's sku. + quantity: + type: number + title: quantity + description: The item's quantity. + barcode: + type: string + title: barcode + description: The item's barcode. + line_item_id: + type: string + title: line_item_id + description: The item's line item id. + inventory_item_id: + type: string + title: inventory_item_id + description: The item's inventory item id. + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + order: + type: object + description: The fulfillment's order. + order_id: 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: + title: order_id + description: The fulfillment's order id. + shipping_option_id: type: string - title: origin_country - description: The inventory item's origin country. - mid_code: + title: shipping_option_id + description: The fulfillment's shipping option id. + data: + type: object + description: The fulfillment's data. + packed_at: type: string - title: mid_code - description: The inventory item's mid code. - material: + title: packed_at + description: The fulfillment's packed at. + format: date-time + shipped_at: type: string - title: material - description: The inventory item's material. - title: + title: shipped_at + description: The fulfillment's shipped at. + format: date-time + delivered_at: type: string - title: title - description: The inventory item's title. - description: + title: delivered_at + description: The fulfillment's delivered at. + format: date-time + canceled_at: type: string - title: description - description: The inventory item's description. - thumbnail: - type: string - title: thumbnail - description: The inventory item's thumbnail. + title: canceled_at + description: The fulfillment's canceled at. + format: date-time metadata: type: object - description: The inventory item's metadata. - properties: {} - AdminPostInvitesInviteAcceptReq: + description: The fulfillment's metadata. + AdminCreatePriceList: type: object description: SUMMARY - x-schemaName: AdminPostInvitesInviteAcceptReq - required: - - first_name - - last_name - properties: - first_name: - type: string - title: first_name - description: The invite's first name. - last_name: - type: string - title: last_name - description: The invite's last name. - AdminPostPaymentsCapturesReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPaymentsCapturesReq - properties: - amount: - type: number - title: amount - description: The payment's amount. - AdminPostPaymentsRefundsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPaymentsRefundsReq - properties: - amount: - type: number - title: amount - description: The payment's amount. - AdminPostPriceListsPriceListPricesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq - required: - - prices - properties: - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - AdminPostPriceListsPriceListPricesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq - required: - - ids - properties: - ids: - type: array - description: The price list's ids. - items: - type: string - title: ids - description: The id's ids. - AdminPostPriceListsPriceListReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsPriceListReq - required: - - prices - properties: - title: - type: string - title: title - description: The price list's title. - description: - type: string - title: description - description: The price list's description. - starts_at: - type: string - title: starts_at - description: The price list's starts at. - ends_at: - type: string - title: ends_at - description: The price list's ends at. - status: {} - type: {} - prices: - type: array - description: The price list's prices. - items: - type: object - description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq - required: - - currency_code - - amount - - variant_id - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - variant_id: - type: string - title: variant_id - description: The price's variant id. - min_quantity: - type: number - title: min_quantity - description: The price's min quantity. - max_quantity: - type: number - title: max_quantity - description: The price's max quantity. - rules: - type: object - description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} - AdminPostPriceListsReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPriceListsReq + x-schemaName: AdminCreatePriceList required: - title - description - - type - - prices + - starts_at + - ends_at properties: title: type: string @@ -2342,19 +5112,31 @@ components: type: string title: ends_at description: The price list's ends at. - status: {} - type: {} + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. prices: type: array description: The price list's prices. items: type: object description: The price's prices. - x-schemaName: AdminPriceListPricesCreateReq required: - currency_code - amount - variant_id + - min_quantity + - max_quantity properties: currency_code: type: string @@ -2379,200 +5161,393 @@ components: rules: type: object description: The price's rules. - properties: {} - rules: - type: object - description: The price list's rules. - properties: {} - AdminPostPricingRuleTypesReq: + AdminCreateProduct: type: object - description: SUMMARY - x-schemaName: AdminPostPricingRuleTypesReq + description: The create's details. + x-schemaName: AdminCreateProduct required: - - name - - rule_attribute - - default_priority + - title properties: - name: + title: type: string - title: name - description: The pricing's name. - rule_attribute: + title: title + description: The create's title. + subtitle: type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. - AdminPostPricingRuleTypesRuleTypeReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPricingRuleTypesRuleTypeReq - properties: - name: + title: subtitle + description: The create's subtitle. + description: type: string - title: name - description: The pricing's name. - rule_attribute: - type: string - title: rule_attribute - description: The pricing's rule attribute. - default_priority: - type: number - title: default_priority - description: The pricing's default priority. - AdminPostPromotionsPromotionReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionReq - properties: - code: - type: string - title: code - description: The promotion's code. - is_automatic: + title: description + description: The create's description. + is_giftcard: type: boolean - title: is_automatic - description: The promotion's is automatic. - type: {} - campaign_id: + title: is_giftcard + description: The create's is giftcard. + discountable: + type: boolean + title: discountable + description: The create's discountable. + images: + type: array + description: The create's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: type: string - title: campaign_id - description: The promotion's campaign id. - campaign: - $ref: '#/components/schemas/AdminPostCampaignsReq' - application_method: - $ref: '#/components/schemas/ApplicationMethodsMethodPostReq' - rules: + title: thumbnail + description: The create's thumbnail. + handle: + type: string + title: handle + description: The create's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The create's type id. + collection_id: + type: string + title: collection_id + description: The create's collection id. + categories: type: array - description: The promotion's rules. + description: The create's categories. items: type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostPromotionsPromotionRulesBatchAddReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq - required: - - rules - properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostPromotionsPromotionRulesBatchRemoveReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq - required: - - rule_ids - properties: - rule_ids: - type: array - description: The promotion's rule ids. - items: - type: string - title: rule_ids - description: The rule id's rule ids. - AdminPostPromotionsPromotionRulesBatchUpdateReq: - type: object - description: SUMMARY - x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq - required: - - rules - properties: - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - x-schemaName: UpdatePromotionRule + description: The category's categories. required: - id - - attribute - - values properties: id: type: string title: id - description: The rule's ID. - operator: {} - description: + description: The category's ID. + tags: + type: array + description: The create's tags. + items: + type: object + description: The tag's tags. + properties: + id: type: string - title: description - description: The rule's description. - attribute: + title: id + description: The tag's ID. + value: type: string - title: attribute - description: The rule's attribute. - values: - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. - AdminPostStockLocationsReq: + title: value + description: The tag's value. + options: + type: array + description: The create's options. + items: + $ref: '#/components/schemas/AdminCreateProductOption' + variants: + type: array + description: The create's variants. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + sales_channels: + type: array + description: The create's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + AdminCreateProductOption: type: object description: SUMMARY - x-schemaName: AdminPostStockLocationsReq + x-schemaName: AdminCreateProductOption + required: + - title + - values + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. + AdminCreateProductVariant: + type: object + description: The create's details. + x-schemaName: AdminCreateProductVariant + required: + - title + - prices + properties: + title: + type: string + title: title + description: The create's title. + sku: + type: string + title: sku + description: The create's sku. + ean: + type: string + title: ean + description: The create's ean. + upc: + type: string + title: upc + description: The create's upc. + barcode: + type: string + title: barcode + description: The create's barcode. + hs_code: + type: string + title: hs_code + description: The create's hs code. + mid_code: + type: string + title: mid_code + description: The create's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The create's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The create's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The create's variant rank. + weight: + type: number + title: weight + description: The create's weight. + length: + type: number + title: length + description: The create's length. + height: + type: number + title: height + description: The create's height. + width: + type: number + title: width + description: The create's width. + origin_country: + type: string + title: origin_country + description: The create's origin country. + material: + type: string + title: material + description: The create's material. + metadata: + type: object + description: The create's metadata. + prices: + type: array + description: The create's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The create's options. + AdminCreateProductVariantPrice: + type: object + description: The price's prices. + x-schemaName: AdminCreateProductVariantPrice + 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. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + AdminCreateSalesChannel: + type: object + description: SUMMARY + x-schemaName: AdminCreateSalesChannel required: - name + - description + - metadata + properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + AdminCreateShipment: + type: object + description: SUMMARY + x-schemaName: AdminCreateShipment + required: + - labels + properties: + labels: + type: array + description: The fulfillment's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + AdminCreateStockLocation: + type: object + description: SUMMARY + x-schemaName: AdminCreateStockLocation + required: + - name + - address_id + - metadata properties: name: type: string title: name description: The stock location's name. address: - $ref: '#/components/schemas/StockLocationAddress' + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. address_id: type: string title: address_id @@ -2580,14 +5555,14 @@ components: metadata: type: object description: The stock location's metadata. - properties: {} - AdminPostTaxRatesReq: + AdminCreateTaxRate: type: object description: SUMMARY - x-schemaName: AdminPostTaxRatesReq + x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - metadata properties: rate: type: number @@ -2603,7 +5578,6 @@ components: items: type: object description: The rule's rules. - x-schemaName: CreateTaxRateRule required: - reference - reference_id @@ -2635,53 +5609,10 @@ components: metadata: type: object description: The tax rate's metadata. - properties: {} - AdminPostTaxRatesTaxRateReq: + AdminCreateTaxRateRule: type: object description: SUMMARY - x-schemaName: AdminPostTaxRatesTaxRateReq - properties: - code: - type: string - title: code - description: The tax rate's code. - name: - type: string - title: name - description: The tax rate's name. - region_id: - type: string - title: region_id - description: The tax rate's region id. - rate: - type: number - title: rate - description: The tax rate's rate. - products: - type: array - description: The tax rate's products. - items: - type: string - title: products - description: The product's products. - shipping_options: - type: array - description: The tax rate's shipping options. - items: - type: string - title: shipping_options - description: The shipping option's shipping options. - product_types: - type: array - description: The tax rate's product types. - items: - type: string - title: product_types - description: The product type's product types. - AdminPostTaxRatesTaxRateRulesReq: - type: object - description: SUMMARY - x-schemaName: AdminPostTaxRatesTaxRateRulesReq + x-schemaName: AdminCreateTaxRateRule required: - reference - reference_id @@ -2694,12 +5625,15 @@ components: type: string title: reference_id description: The tax rate's reference id. - AdminPostTaxRegionsReq: + AdminCreateTaxRegion: type: object description: SUMMARY - x-schemaName: AdminPostTaxRegionsReq + x-schemaName: AdminCreateTaxRegion required: - country_code + - province_code + - parent_id + - metadata properties: country_code: type: string @@ -2714,15 +5648,55 @@ components: title: parent_id description: The tax region's parent id. default_tax_rate: - $ref: '#/components/schemas/CreateDefaultTaxRate' + type: object + description: The tax region's default tax rate. + required: + - name + - metadata + properties: + rate: + type: number + title: rate + description: The default tax rate's rate. + code: + type: string + title: code + description: The default tax rate's code. + name: + type: string + title: name + description: The default tax rate's name. + is_combinable: + type: string + enum: + - 'true' + - 'false' + metadata: + type: object + description: The default tax rate's metadata. metadata: type: object description: The tax region's metadata. - properties: {} - AdminPostWorkflowsAsyncResponseReq: + AdminCreateVariantInventoryItem: type: object description: SUMMARY - x-schemaName: AdminPostWorkflowsAsyncResponseReq + x-schemaName: AdminCreateVariantInventoryItem + required: + - required_quantity + - inventory_item_id + properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + inventory_item_id: + type: string + title: inventory_item_id + description: The product's inventory item id. + AdminCreateWorkflowsAsyncResponse: + type: object + description: SUMMARY + x-schemaName: AdminCreateWorkflowsAsyncResponse required: - transaction_id - step_id @@ -2737,22 +5711,2151 @@ components: description: The workflows execution's step id. response: {} compensate_input: {} - action: {} - AdminPostWorkflowsRunReq: + action: + type: string + enum: + - invoke + - compensate + AdminCreateWorkflowsRun: type: object description: SUMMARY - x-schemaName: AdminPostWorkflowsRunReq + x-schemaName: AdminCreateWorkflowsRun properties: input: {} transaction_id: type: string title: transaction_id description: The workflows execution's transaction id. - AdminUpdateUserRequest: + AdminCustomer: + type: object + description: The customer's details. + x-schemaName: AdminCustomer + required: + - has_account + - id + - email + - default_billing_address_id + - default_shipping_address_id + - company_name + - first_name + - last_name + - addresses + properties: + has_account: + type: boolean + title: has_account + description: The customer's has account. + groups: + type: array + description: The customer's groups. + items: + $ref: '#/components/schemas/AdminCustomerGroup' + id: + type: string + title: id + description: The customer's ID. + email: + type: string + title: email + description: The customer's email. + format: email + default_billing_address_id: + type: string + title: default_billing_address_id + description: The customer's default billing address id. + default_shipping_address_id: + type: string + title: default_shipping_address_id + description: The customer's default shipping address id. + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + addresses: + type: array + description: The customer's addresses. + items: + $ref: '#/components/schemas/BaseCustomerAddress' + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + created_by: + type: string + title: created_by + description: The customer's created by. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The customer's deleted at. + created_at: + type: string + format: date-time + title: created_at + description: The customer's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The customer's updated at. + AdminCustomerGroup: + type: object + description: The group's groups. + x-schemaName: AdminCustomerGroup + required: + - id + - name + - customers + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The group's ID. + name: + type: string + title: name + description: The group's name. + customers: + type: array + description: The group's customers. + items: + $ref: '#/components/schemas/BaseCustomer' + metadata: + type: object + description: The group's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The group's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The group's updated at. + AdminFulfillmentProvider: + type: object + description: The shipping option's provider. + x-schemaName: AdminFulfillmentProvider + AdminFulfillmentSet: + type: object + description: The fulfillment set's details. + x-schemaName: AdminFulfillmentSet + required: + - id + - name + - type + - service_zones + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + name: + type: string + title: name + description: The fulfillment set's name. + type: + type: string + title: type + description: The fulfillment set's type. + service_zones: + type: array + description: The fulfillment set's service zones. + items: + $ref: '#/components/schemas/AdminServiceZone' + created_at: + type: string + format: date-time + title: created_at + description: The fulfillment set's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The fulfillment set's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The fulfillment set's deleted at. + AdminFulfillmentSetDeleteResponse: type: object description: SUMMARY - x-schemaName: AdminUpdateUserRequest + x-schemaName: AdminFulfillmentSetDeleteResponse required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The fulfillment set's ID. + object: + type: string + title: object + description: The fulfillment set's object. + default: fulfillment_set + deleted: + type: boolean + title: deleted + description: The fulfillment set's deleted. + parent: + type: object + description: The fulfillment set's parent. + AdminFulfillmentSetResponse: + type: object + description: SUMMARY + x-schemaName: AdminFulfillmentSetResponse + required: + - fulfillment_set + properties: + fulfillment_set: + $ref: '#/components/schemas/AdminFulfillmentSet' + AdminGeoZone: + type: object + description: The geo zone's geo zones. + x-schemaName: AdminGeoZone + AdminGetUploadParams: + type: object + description: SUMMARY + x-schemaName: AdminGetUploadParams + properties: + fields: + type: string + title: fields + description: The upload's fields. + AdminOrderCancelFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCancelFulfillment + properties: + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + AdminOrderCreateFulfillment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCreateFulfillment + required: + - items + - location_id + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + location_id: + type: string + title: location_id + description: The order's location id. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + AdminOrderCreateShipment: + type: object + description: SUMMARY + x-schemaName: AdminOrderCreateShipment + required: + - items + - metadata + properties: + items: + type: array + description: The order's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + labels: + type: array + description: The order's labels. + items: + type: object + description: The label's labels. + required: + - tracking_number + - tracking_url + - label_url + properties: + tracking_number: + type: string + title: tracking_number + description: The label's tracking number. + tracking_url: + type: string + title: tracking_url + description: The label's tracking url. + label_url: + type: string + title: label_url + description: The label's label url. + no_notification: + type: boolean + title: no_notification + description: The order's no notification. + metadata: + type: object + description: The order's metadata. + AdminPostReceiveReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReceiveReturnsReqSchema + required: + - return_id + - items + - internal_note + properties: + return_id: + type: string + title: return_id + description: The return's return id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + internal_note: + type: string + title: internal_note + description: The return's internal note. + AdminPostReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: AdminPostReturnsReqSchema + required: + - order_id + - items + - return_shipping + - internal_note + - location_id + properties: + order_id: + type: string + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + internal_note: + type: string + title: internal_note + description: The return's internal note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + refund_amount: + type: number + title: refund_amount + description: The return's refund amount. + location_id: + type: string + title: location_id + description: The return's location id. + AdminPrice: + type: object + description: The price's prices. + x-schemaName: AdminPrice + required: + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The price's ID. + title: + type: string + title: title + description: The price's title. + currency_code: + type: string + title: currency_code + description: The price's currency code. + amount: + type: number + title: amount + description: The price's amount. + raw_amount: + type: object + description: The price's raw amount. + min_quantity: + type: number + title: min_quantity + description: The price's min quantity. + max_quantity: + type: number + title: max_quantity + description: The price's max quantity. + price_set_id: + type: string + title: price_set_id + description: The price's price set id. + created_at: + type: string + format: date-time + title: created_at + description: The price's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The price's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The price's deleted at. + AdminProduct: + type: object + description: The product's parent. + x-schemaName: AdminProduct + required: + - type + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id + properties: + collection: + $ref: '#/components/schemas/AdminCollection' + categories: + type: array + description: The parent's categories. + items: + $ref: '#/components/schemas/AdminProductCategory' + sales_channels: + type: array + description: The parent's sales channels. + items: + $ref: '#/components/schemas/AdminSalesChannel' + variants: + type: array + description: The parent's variants. + items: + $ref: '#/components/schemas/AdminProductVariant' + type: + type: object + title: + type: string + title: title + description: The parent's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The parent's length. + options: + type: array + description: The parent's options. + items: + $ref: '#/components/schemas/BaseProductOption' + description: + type: string + title: description + description: The parent's description. + id: + type: string + title: id + description: The parent's ID. + handle: + type: string + title: handle + description: The parent's handle. + metadata: + type: object + description: The parent's metadata. + hs_code: + type: string + title: hs_code + description: The parent's hs code. + weight: + type: number + title: weight + description: The parent's weight. + height: + type: number + title: height + description: The parent's height. + width: + type: number + title: width + description: The parent's width. + origin_country: + type: string + title: origin_country + description: The parent's origin country. + mid_code: + type: string + title: mid_code + description: The parent's mid code. + material: + type: string + title: material + description: The parent's material. + thumbnail: + type: string + title: thumbnail + description: The parent's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The parent's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The parent's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The parent's deleted at. + subtitle: + type: string + title: subtitle + description: The parent's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The parent's is giftcard. + collection_id: + type: string + title: collection_id + description: The parent's collection id. + type_id: + type: string + title: type_id + description: The parent's type id. + tags: + type: array + description: The parent's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + images: + type: array + description: The parent's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The parent's discountable. + external_id: + type: string + title: external_id + description: The parent's external id. + AdminProductCategory: + type: object + description: The category's categories. + x-schemaName: AdminProductCategory + required: + - category_children + - parent_category + - name + - description + - id + - handle + - created_at + - updated_at + - deleted_at + - parent_category_id + - is_internal + - is_active + - rank + properties: + category_children: + type: array + description: The category's category children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + handle: + type: string + title: handle + description: The category's handle. + created_at: + type: string + format: date-time + title: created_at + description: The category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The category's deleted at. + parent_category_id: + type: string + title: parent_category_id + description: The category's parent category id. + is_internal: + type: boolean + title: is_internal + description: The category's is internal. + is_active: + type: boolean + title: is_active + description: The category's is active. + rank: + type: number + title: rank + description: The category's rank. + AdminProductCategoryListResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryListResponse + required: + - limit + - offset + - count + - product_categories + properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: '#/components/schemas/AdminProductCategory' + AdminProductCategoryResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductCategoryResponse + required: + - product_category + properties: + product_category: + $ref: '#/components/schemas/AdminProductCategory' + AdminProductDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + type: object + description: The product's parent. + AdminProductOption: + type: object + description: The product's product option. + x-schemaName: AdminProductOption + required: + - id + - title + properties: + id: + type: string + title: id + description: The product option's ID. + title: + type: string + title: title + description: The product option's title. + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The product option's product id. + values: + type: array + description: The product option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + metadata: + type: object + description: The product option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product option's deleted at. + AdminProductOptionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductOptionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: product_option + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProduct' + AdminProductOptionResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductOptionResponse + required: + - product_option + properties: + product_option: + $ref: '#/components/schemas/AdminProductOption' + AdminProductResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductResponse + required: + - product + properties: + product: + $ref: '#/components/schemas/AdminProduct' + AdminProductVariant: + type: object + description: The updated's details. + x-schemaName: AdminProductVariant + required: + - prices + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at + properties: + prices: + type: array + description: The updated's prices. + items: + $ref: '#/components/schemas/AdminPrice' + id: + type: string + title: id + description: The updated's ID. + title: + type: string + title: title + description: The updated's title. + sku: + type: string + title: sku + description: The updated's sku. + barcode: + type: string + title: barcode + description: The updated's barcode. + ean: + type: string + title: ean + description: The updated's ean. + upc: + type: string + title: upc + description: The updated's upc. + allow_backorder: + type: boolean + title: allow_backorder + description: The updated's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The updated's manage inventory. + hs_code: + type: string + title: hs_code + description: The updated's hs code. + origin_country: + type: string + title: origin_country + description: The updated's origin country. + mid_code: + type: string + title: mid_code + description: The updated's mid code. + material: + type: string + title: material + description: The updated's material. + weight: + type: number + title: weight + description: The updated's weight. + length: + type: number + title: length + description: The updated's length. + height: + type: number + title: height + description: The updated's height. + width: + type: number + title: width + description: The updated's width. + options: + type: array + description: The updated's options. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The updated's product id. + variant_rank: + type: number + title: variant_rank + description: The updated's variant rank. + created_at: + type: string + format: date-time + title: created_at + description: The updated's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The updated's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The updated's deleted at. + metadata: + type: object + description: The updated's metadata. + AdminProductVariantDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The product's ID. + object: + type: string + title: object + description: The product's object. + default: variant + deleted: + type: boolean + title: deleted + description: The product's deleted. + parent: + $ref: '#/components/schemas/AdminProduct' + AdminProductVariantParams: + type: object + description: The product's variants. + x-schemaName: AdminProductVariantParams + properties: + q: + type: string + title: q + description: The variant's q. + id: + oneOf: + - type: string + title: id + description: The variant's ID. + - type: array + description: The variant's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The variant's sku. + - type: array + description: The variant's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The variant's product id. + - type: array + description: The variant's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The variant's options. + limit: + type: number + title: limit + description: The variant's limit. + offset: + type: number + title: offset + description: The variant's offset. + order: + type: string + title: order + description: The variant's order. + fields: + type: string + title: fields + description: The variant's fields. + $and: + type: array + description: The variant's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $and's q. + id: + oneOf: + - type: string + title: id + description: The $and's ID. + - type: array + description: The $and's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $and's sku. + - type: array + description: The $and's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $and's product id. + - type: array + description: The $and's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $and's options. + limit: + type: number + title: limit + description: The $and's limit. + offset: + type: number + title: offset + description: The $and's offset. + order: + type: string + title: order + description: The $and's order. + fields: + type: string + title: fields + description: The $and's fields. + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $and's details. + properties: + $and: + type: array + description: The $and's details. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $and's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + $or: + type: array + description: The variant's $or. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + properties: + q: + type: string + title: q + description: The $or's q. + id: + oneOf: + - type: string + title: id + description: The $or's ID. + - type: array + description: The $or's ID. + items: + type: string + title: id + description: The id's ID. + sku: + oneOf: + - type: string + title: sku + description: The $or's sku. + - type: array + description: The $or's sku. + items: + type: string + title: sku + description: The sku's details. + product_id: + oneOf: + - type: string + title: product_id + description: The $or's product id. + - type: array + description: The $or's product id. + items: + type: string + title: product_id + description: The product id's details. + options: + type: object + description: The $or's options. + limit: + type: number + title: limit + description: The $or's limit. + offset: + type: number + title: offset + description: The $or's offset. + order: + type: string + title: order + description: The $or's order. + fields: + type: string + title: fields + description: The $or's fields. + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + - type: object + description: The $or's details. + properties: + $and: + type: array + description: The $or's $and. + items: + oneOf: + - type: object + description: The $and's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $and's details. + $or: + type: array + description: The $or's details. + items: + oneOf: + - type: object + description: The $or's details. + x-schemaName: BaseProductVariantParams + - type: object + description: The $or's details. + AdminProductVariantResponse: + type: object + description: SUMMARY + x-schemaName: AdminProductVariantResponse + required: + - variant + properties: + variant: + $ref: '#/components/schemas/AdminProductVariant' + AdminRevokeApiKey: + type: object + description: SUMMARY + x-schemaName: AdminRevokeApiKey + properties: + revoke_in: + type: number + title: revoke_in + description: The api key's revoke in. + AdminSalesChannel: + type: object + description: The sales channel's sales channels. + x-schemaName: AdminSalesChannel + required: + - id + - name + - description + - is_disabled + - metadata + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The sales channel's ID. + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The sales channel's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The sales channel's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The sales channel's deleted at. + AdminServiceZone: + type: object + description: The service zone's service zones. + x-schemaName: AdminServiceZone + required: + - id + - name + - fulfillment_set_id + - geo_zones + - shipping_options + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The service zone's ID. + name: + type: string + title: name + description: The service zone's name. + fulfillment_set_id: + type: string + title: fulfillment_set_id + description: The service zone's fulfillment set id. + geo_zones: + type: array + description: The service zone's geo zones. + items: + $ref: '#/components/schemas/AdminGeoZone' + shipping_options: + type: array + description: The service zone's shipping options. + items: + $ref: '#/components/schemas/AdminShippingOption' + created_at: + type: string + format: date-time + title: created_at + description: The service zone's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The service zone's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The service zone's deleted at. + AdminServiceZoneResponse: + type: object + description: SUMMARY + x-schemaName: AdminServiceZoneResponse + required: + - service_zone + properties: + service_zone: + $ref: '#/components/schemas/AdminServiceZone' + AdminShippingOption: + type: object + description: The shipping option's shipping options. + x-schemaName: AdminShippingOption + AdminShippingOptionDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingOptionDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The shipping option's ID. + object: + type: string + title: object + description: The shipping option's object. + default: shipping_option + deleted: + type: boolean + title: deleted + description: The shipping option's deleted. + parent: + type: object + description: The shipping option's parent. + AdminShippingOptionResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingOptionResponse + required: + - shipping_option + properties: + shipping_option: + $ref: '#/components/schemas/AdminShippingOption' + AdminShippingProfile: + type: object + description: The shipping option's shipping profile. + x-schemaName: AdminShippingProfile + AdminShippingProfileDeleteResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingProfileDeleteResponse + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The shipping profile's ID. + object: + type: string + title: object + description: The shipping profile's object. + default: shipping_profile + deleted: + type: boolean + title: deleted + description: The shipping profile's deleted. + parent: + type: object + description: The shipping profile's parent. + AdminShippingProfileResponse: + type: object + description: SUMMARY + x-schemaName: AdminShippingProfileResponse + required: + - shipping_profile + properties: + shipping_profile: + $ref: '#/components/schemas/AdminShippingProfile' + AdminUpdateApiKey: + type: object + description: SUMMARY + x-schemaName: AdminUpdateApiKey + required: + - title + properties: + title: + type: string + title: title + description: The api key's title. + AdminUpdateCampaign: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCampaign + required: + - description + - starts_at + - ends_at + properties: + name: + type: string + title: name + description: The campaign's name. + campaign_identifier: + type: string + title: campaign_identifier + description: The campaign's campaign identifier. + description: + type: string + title: description + description: The campaign's description. + budget: + type: object + description: The campaign's budget. + properties: + limit: + type: number + title: limit + description: The budget's limit. + starts_at: + type: string + title: starts_at + description: The campaign's starts at. + format: date-time + ends_at: + type: string + title: ends_at + description: The campaign's ends at. + format: date-time + promotions: + type: array + description: The campaign's promotions. + items: + type: object + description: The promotion's promotions. + required: + - id + properties: + id: + type: string + title: id + description: The promotion's ID. + AdminUpdateCollection: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCollection + required: + - metadata + properties: + title: + type: string + title: title + description: The collection's title. + handle: + type: string + title: handle + description: The collection's handle. + metadata: + type: object + description: The collection's metadata. + AdminUpdateCustomer: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + - metadata + properties: + email: + type: string + title: email + description: The customer's email. + format: email + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + metadata: + type: object + description: The customer's metadata. + AdminUpdateCustomerGroup: + type: object + description: SUMMARY + x-schemaName: AdminUpdateCustomerGroup + required: + - name + - metadata + properties: + name: + type: string + title: name + description: The customer group's name. + metadata: + type: object + description: The customer group's metadata. + AdminUpdatePriceList: + type: object + description: SUMMARY + x-schemaName: AdminUpdatePriceList + required: + - description + - starts_at + - ends_at + properties: + title: + type: string + title: title + description: The price list's title. + description: + type: string + title: description + description: The price list's description. + starts_at: + type: string + title: starts_at + description: The price list's starts at. + ends_at: + type: string + title: ends_at + description: The price list's ends at. + status: + type: string + enum: + - active + - draft + type: + type: string + enum: + - sale + - override + rules: + type: object + description: The price list's rules. + AdminUpdateProduct: + type: object + description: The update's details. + x-schemaName: AdminUpdateProduct + properties: + title: + type: string + title: title + description: The update's title. + subtitle: + type: string + title: subtitle + description: The update's subtitle. + description: + type: string + title: description + description: The update's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The update's is giftcard. + discountable: + type: boolean + title: discountable + description: The update's discountable. + images: + type: array + description: The update's images. + items: + type: object + description: The image's images. + required: + - url + properties: + url: + type: string + title: url + description: The image's url. + thumbnail: + type: string + title: thumbnail + description: The update's thumbnail. + handle: + type: string + title: handle + description: The update's handle. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + type_id: + type: string + title: type_id + description: The update's type id. + collection_id: + type: string + title: collection_id + description: The update's collection id. + categories: + type: array + description: The update's categories. + items: + type: object + description: The category's categories. + required: + - id + properties: + id: + type: string + title: id + description: The category's ID. + tags: + type: array + description: The update's tags. + items: + type: object + description: The tag's tags. + properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + options: + type: array + description: The update's options. + items: + $ref: '#/components/schemas/AdminUpdateProductOption' + variants: + type: array + description: The update's variants. + items: + $ref: '#/components/schemas/AdminCreateProductVariant' + sales_channels: + type: array + description: The update's sales channels. + items: + type: object + description: The sales channel's sales channels. + required: + - id + properties: + id: + type: string + title: id + description: The sales channel's ID. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + AdminUpdateProductOption: + type: object + description: SUMMARY + x-schemaName: AdminUpdateProductOption + properties: + title: + type: string + title: title + description: The product's title. + values: + type: array + description: The product's values. + items: + type: string + title: values + description: The value's values. + AdminUpdateProductVariant: + type: object + description: The update's details. + x-schemaName: AdminUpdateProductVariant + properties: + title: + type: string + title: title + description: The update's title. + sku: + type: string + title: sku + description: The update's sku. + ean: + type: string + title: ean + description: The update's ean. + upc: + type: string + title: upc + description: The update's upc. + barcode: + type: string + title: barcode + description: The update's barcode. + hs_code: + type: string + title: hs_code + description: The update's hs code. + mid_code: + type: string + title: mid_code + description: The update's mid code. + allow_backorder: + type: boolean + title: allow_backorder + description: The update's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The update's manage inventory. + variant_rank: + type: number + title: variant_rank + description: The update's variant rank. + weight: + type: number + title: weight + description: The update's weight. + length: + type: number + title: length + description: The update's length. + height: + type: number + title: height + description: The update's height. + width: + type: number + title: width + description: The update's width. + origin_country: + type: string + title: origin_country + description: The update's origin country. + material: + type: string + title: material + description: The update's material. + metadata: + type: object + description: The update's metadata. + prices: + type: array + description: The update's prices. + items: + $ref: '#/components/schemas/AdminCreateProductVariantPrice' + options: + type: object + description: The update's options. + AdminUpdateSalesChannel: + type: object + description: SUMMARY + x-schemaName: AdminUpdateSalesChannel + required: + - description + - metadata + properties: + name: + type: string + title: name + description: The sales channel's name. + description: + type: string + title: description + description: The sales channel's description. + is_disabled: + type: boolean + title: is_disabled + description: The sales channel's is disabled. + metadata: + type: object + description: The sales channel's metadata. + AdminUpdateStockLocation: + type: object + description: SUMMARY + x-schemaName: AdminUpdateStockLocation + required: + - address_id + - metadata + properties: + name: + type: string + title: name + description: The stock location's name. + address: + type: object + description: The stock location's address. + required: + - address_1 + - address_2 + - company + - city + - country_code + - phone + - postal_code + - province + properties: + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + company: + type: string + title: company + description: The address's company. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + address_id: + type: string + title: address_id + description: The stock location's address id. + metadata: + type: object + description: The stock location's metadata. + AdminUpdateStore: + type: object + description: SUMMARY + x-schemaName: AdminUpdateStore + required: + - name + - default_sales_channel_id + - default_region_id + - default_location_id + - metadata + properties: + name: + type: string + title: name + description: The store's name. + supported_currencies: + type: array + description: The store's supported currencies. + items: + type: object + description: The supported currency's supported currencies. + required: + - currency_code + properties: + currency_code: + type: string + title: currency_code + description: The supported currency's currency code. + is_default: + type: boolean + title: is_default + description: The supported currency's is default. + default_sales_channel_id: + type: string + title: default_sales_channel_id + description: The store's default sales channel id. + default_region_id: + type: string + title: default_region_id + description: The store's default region id. + default_location_id: + type: string + title: default_location_id + description: The store's default location id. + metadata: + type: object + description: The store's metadata. + AdminUpdateTaxRate: + type: object + description: SUMMARY + x-schemaName: AdminUpdateTaxRate + required: + - metadata + properties: + rate: + type: number + title: rate + description: The tax rate's rate. + code: + type: string + title: code + description: The tax rate's code. + rules: + type: array + description: The tax rate's rules. + items: + type: object + description: The rule's rules. + required: + - reference + - reference_id + properties: + reference: + type: string + title: reference + description: The rule's reference. + reference_id: + type: string + title: reference_id + description: The rule's reference id. + name: + type: string + title: name + description: The tax rate's name. + is_default: + type: boolean + title: is_default + description: The tax rate's is default. + is_combinable: + type: boolean + title: is_combinable + description: The tax rate's is combinable. + metadata: + type: object + description: The tax rate's metadata. + AdminUpdateUser: + type: object + description: SUMMARY + x-schemaName: AdminUpdateUser + required: + - first_name + - last_name - avatar_url properties: first_name: @@ -2767,123 +7870,658 @@ components: type: string title: avatar_url description: The user's avatar url. - ApplicationMethodsMethodPostReq: + AdminUpdateVariantInventoryItem: type: object - description: The promotion's application method. - x-schemaName: ApplicationMethodsMethodPostReq + description: SUMMARY + x-schemaName: AdminUpdateVariantInventoryItem + required: + - required_quantity properties: + required_quantity: + type: number + title: required_quantity + description: The product's required quantity. + BaseCollection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + BaseCustomer: + type: object + description: The customer's customers. + x-schemaName: BaseCustomer + BaseCustomerAddress: + type: object + description: The address's addresses. + x-schemaName: BaseCustomerAddress + required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The address's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The address's is default billing. + customer_id: + type: string + title: customer_id + description: The address's customer id. + company: + type: string + title: company + description: The address's company. + first_name: + type: string + title: first_name + description: The address's first name. + last_name: + type: string + title: last_name + description: The address's last name. + address_1: + type: string + title: address_1 + description: The address's address 1. + address_2: + type: string + title: address_2 + description: The address's address 2. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + province: + type: string + title: province + description: The address's province. + postal_code: + type: string + title: postal_code + description: The address's postal code. + phone: + type: string + title: phone + description: The address's phone. + metadata: + type: object + description: The address's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The address's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's updated at. + BaseProduct: + type: object + description: The updated's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - tags + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. description: type: string title: description - description: The application method's description. + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + $ref: '#/components/schemas/BaseCollection' + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + $ref: '#/components/schemas/BaseProductCategory' + type: + type: object + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/BaseProductVariant' + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/BaseProductOption' + images: + type: array + description: The product's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + BaseProductCategory: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + BaseProductImage: + type: object + description: The image's images. + x-schemaName: BaseProductImage + BaseProductOption: + type: object + description: The option's options. + x-schemaName: BaseProductOption + BaseProductOptionValue: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The option's ID. value: type: string title: value - description: The application method's value. - max_quantity: - type: number - title: max_quantity - description: The application method's max quantity. - type: {} - target_type: {} - allocation: {} - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - x-schemaName: PromotionRule - required: - - operator - - attribute - - values - properties: - operator: {} - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. - apply_to_quantity: - type: number - title: apply_to_quantity - description: The application method's apply to quantity. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - CampaignBudget: - type: object - description: The campaign's budget. - x-schemaName: CampaignBudget - properties: - type: {} - limit: - type: number - title: limit - description: The budget's limit. - CreateDefaultTaxRate: - type: object - description: The tax region's default tax rate. - x-schemaName: CreateDefaultTaxRate - required: - - name - properties: - rate: - type: number - title: rate - description: The default tax rate's rate. - code: + description: The option's value. + option: + $ref: '#/components/schemas/BaseProductOption' + option_id: type: string - title: code - description: The default tax rate's code. - name: - type: string - title: name - description: The default tax rate's name. + title: option_id + description: The option's option id. metadata: type: object - description: The default tax rate's metadata. - properties: {} + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. + BaseProductTag: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + BaseProductVariant: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + CreateAddress: + type: object + description: The cart's shipping address. + x-schemaName: CreateAddress + properties: + customer_id: + type: string + title: customer_id + description: The shipping address's customer id. + company: + type: string + title: company + description: The shipping address's company. + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. + province: + type: string + title: province + description: The shipping address's province. + postal_code: + type: string + title: postal_code + description: The shipping address's postal code. + phone: + type: string + title: phone + description: The shipping address's phone. + metadata: + type: object + description: The shipping address's metadata. + CreateCartAddress: + type: object + description: The cart's billing address. + x-schemaName: CreateCartAddress + properties: + first_name: + type: string + title: first_name + description: The billing address's first name. + last_name: + type: string + title: last_name + description: The billing address's last name. + phone: + type: string + title: phone + description: The billing address's phone. + company: + type: string + title: company + description: The billing address's company. + address_1: + type: string + title: address_1 + description: The billing address's address 1. + address_2: + type: string + title: address_2 + description: The billing address's address 2. + city: + type: string + title: city + description: The billing address's city. + country_code: + type: string + title: country_code + description: The billing address's country code. + province: + type: string + title: province + description: The billing address's province. + postal_code: + type: string + title: postal_code + description: The billing address's postal code. + metadata: + type: object + description: The billing address's metadata. + CreateCartCreateLineItem: + type: object + description: The item's items. + x-schemaName: CreateCartCreateLineItem + required: + - quantity + - variant_id + properties: + quantity: + type: string + title: quantity + description: The item's quantity. + variant_id: + type: string + title: variant_id + description: The item's variant id. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + is_giftcard: + type: boolean + title: is_giftcard + description: The item's is giftcard. + compare_at_unit_price: + type: string + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: string + title: unit_price + description: The item's unit price. + metadata: + type: object + description: The item's metadata. + CreateCartWorkflowInput: + type: object + description: SUMMARY + x-schemaName: CreateCartWorkflowInput + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + shipping_address: + oneOf: + - type: string + title: shipping_address + description: The cart's shipping address. + - $ref: '#/components/schemas/CreateCartAddress' + billing_address: + oneOf: + - type: string + title: billing_address + description: The cart's billing address. + - $ref: '#/components/schemas/CreateCartAddress' + metadata: + type: object + description: The cart's metadata. + items: + type: array + description: The cart's items. + items: + $ref: '#/components/schemas/CreateCartCreateLineItem' + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. + CreateOrderReturnReason: + type: object + description: SUMMARY + x-schemaName: CreateOrderReturnReason + required: + - value + - label + properties: + value: + type: string + title: value + description: The return reason's value. + label: + type: string + title: label + description: The return reason's label. + description: + type: string + title: description + description: The return reason's description. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The return reason's parent return reason id. + metadata: + type: object + description: The return reason's metadata. + CreateUser: + type: object + description: SUMMARY + x-schemaName: CreateUser + required: + - email + properties: + email: + type: string + title: email + description: The user's email. + format: email + first_name: + type: string + title: first_name + description: The user's first name. + last_name: + type: string + title: last_name + description: The user's last name. + avatar_url: + type: string + title: avatar_url + description: The user's avatar url. + metadata: + type: object + description: The user's metadata. Error: title: Response Error type: object @@ -2918,76 +8556,578 @@ components: - unexpected_state - invalid_argument - unknown_error - MultipleErrors: - title: Multiple Errors + StoreAddCartLineItem: type: object - properties: - errors: - type: array - description: Array of errors - items: - $ref: '#/components/schemas/Error' - message: - type: string - default: Provided request body contains errors. Please check the data and retry the request - StockLocationAddress: - type: object - description: The stock location's address. - x-schemaName: StockLocationAddress + description: SUMMARY + x-schemaName: StoreAddCartLineItem required: - - address_1 - - country_code + - variant_id + - quantity + - metadata properties: - address_1: + variant_id: type: string - title: address_1 - description: The address's address 1. - address_2: + title: variant_id + description: The cart's variant id. + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. + StoreCalculateCartTaxes: + type: object + description: SUMMARY + x-schemaName: StoreCalculateCartTaxes + properties: + fields: type: string - title: address_2 - description: The address's address 2. - company: + title: fields + description: The cart's fields. + StoreCreateCustomer: + type: object + description: SUMMARY + x-schemaName: StoreCreateCustomer + required: + - email + - company_name + - first_name + - last_name + - phone + properties: + email: type: string - title: company - description: The address's company. - city: + title: email + description: The customer's email. + format: email + company_name: type: string - title: city - description: The address's city. - country_code: + title: company_name + description: The customer's company name. + first_name: type: string - title: country_code - description: The address's country code. + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. phone: type: string title: phone - description: The address's phone. - postal_code: + description: The customer's phone. + StorePostReturnsReqSchema: + type: object + description: SUMMARY + x-schemaName: StorePostReturnsReqSchema + required: + - order_id + - items + - return_shipping + - note + - location_id + properties: + order_id: type: string - title: postal_code - description: The address's postal code. + title: order_id + description: The return's order id. + items: + type: array + description: The return's items. + items: + type: object + description: The item's items. + required: + - id + - quantity + - reason_id + - note + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + reason_id: + type: string + title: reason_id + description: The item's reason id. + note: + type: string + title: note + description: The item's note. + return_shipping: + type: object + description: The return's return shipping. + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The return shipping's option id. + price: + type: number + title: price + description: The return shipping's price. + note: + type: string + title: note + description: The return's note. + receive_now: + type: boolean + title: receive_now + description: The return's receive now. + location_id: + type: string + title: location_id + description: The return's location id. + StoreProduct: + type: object + description: The product's products. + x-schemaName: StoreProduct + required: + - title + - status + - length + - options + - description + - id + - handle + - hs_code + - weight + - height + - width + - origin_country + - mid_code + - material + - thumbnail + - created_at + - updated_at + - deleted_at + - variants + - subtitle + - is_giftcard + - collection_id + - type_id + - tags + - images + - discountable + - external_id + properties: + categories: + type: array + description: The product's categories. + items: + type: object + type: + type: object + title: + type: string + title: title + description: The product's title. + status: + type: string + enum: + - draft + - proposed + - published + - rejected + length: + type: number + title: length + description: The product's length. + options: + type: array + description: The product's options. + items: + $ref: '#/components/schemas/BaseProductOption' + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + handle: + type: string + title: handle + description: The product's handle. + metadata: + type: object + description: The product's metadata. + hs_code: + type: string + title: hs_code + description: The product's hs code. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + width: + type: number + title: width + description: The product's width. + origin_country: + type: string + title: origin_country + description: The product's origin country. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + variants: + type: array + description: The product's variants. + items: + $ref: '#/components/schemas/BaseProductVariant' + subtitle: + type: string + title: subtitle + description: The product's subtitle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + collection: + $ref: '#/components/schemas/BaseCollection' + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + $ref: '#/components/schemas/BaseProductTag' + images: + type: array + description: The product's images. + items: + $ref: '#/components/schemas/BaseProductImage' + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + StoreProductCategory: + type: object + description: The product category's details. + x-schemaName: StoreProductCategory + required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at + properties: + products: + type: array + description: The product category's products. + items: + $ref: '#/components/schemas/StoreProduct' + id: + type: string + title: id + description: The product category's ID. + 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_active: + type: boolean + title: is_active + description: The product category's is active. + is_internal: + type: boolean + title: is_internal + description: The product category's is internal. + rank: + type: number + title: rank + description: The product category's rank. + parent_category_id: + type: string + title: parent_category_id + description: The product category's parent category id. + parent_category: + $ref: '#/components/schemas/BaseProductCategory' + category_children: + type: array + description: The product category's category children. + items: + $ref: '#/components/schemas/BaseProductCategory' + created_at: + type: string + format: date-time + title: created_at + description: The product category's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product category's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product category's deleted at. + StoreProductCategoryListResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductCategoryListResponse + required: + - limit + - offset + - count + - product_categories + properties: + limit: + type: number + title: limit + description: The product category's limit. + offset: + type: number + title: offset + description: The product category's offset. + count: + type: number + title: count + description: The product category's count. + product_categories: + type: array + description: The product category's product categories. + items: + $ref: '#/components/schemas/StoreProductCategory' + StoreProductCategoryResponse: + type: object + description: SUMMARY + x-schemaName: StoreProductCategoryResponse + required: + - product_category + properties: + product_category: + $ref: '#/components/schemas/StoreProductCategory' + StoreUpdateCartLineItem: + type: object + description: SUMMARY + x-schemaName: StoreUpdateCartLineItem + required: + - quantity + - metadata + properties: + quantity: + type: number + title: quantity + description: The cart's quantity. + metadata: + type: object + description: The cart's metadata. + StoreUpdateCustomer: + type: object + description: SUMMARY + x-schemaName: StoreUpdateCustomer + required: + - company_name + - first_name + - last_name + - phone + properties: + company_name: + type: string + title: company_name + description: The customer's company name. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + UpdateAddress: + type: object + description: The cart's shipping address. + x-schemaName: UpdateAddress + required: + - id + properties: + id: + type: string + title: id + description: The shipping address's ID. + customer_id: + type: string + title: customer_id + description: The shipping address's customer id. + company: + type: string + title: company + description: The shipping address's company. + first_name: + type: string + title: first_name + description: The shipping address's first name. + last_name: + type: string + title: last_name + description: The shipping address's last name. + address_1: + type: string + title: address_1 + description: The shipping address's address 1. + address_2: + type: string + title: address_2 + description: The shipping address's address 2. + city: + type: string + title: city + description: The shipping address's city. + country_code: + type: string + title: country_code + description: The shipping address's country code. province: type: string title: province - description: The address's province. - StorePostCartsCartTaxesReq: - type: object - description: SUMMARY - x-schemaName: StorePostCartsCartTaxesReq - properties: {} - StorePostPaymentCollectionsPaymentSessionReq: - type: object - description: SUMMARY - x-schemaName: StorePostPaymentCollectionsPaymentSessionReq - required: - - provider_id - properties: - provider_id: + description: The shipping address's province. + postal_code: type: string - title: provider_id - description: The payment collection's provider id. - context: {} - data: + title: postal_code + description: The shipping address's postal code. + phone: + type: string + title: phone + description: The shipping address's phone. + metadata: type: object - description: The payment collection's data. - properties: {} + description: The shipping address's metadata. + UpdateCartData: + type: object + description: SUMMARY + x-schemaName: UpdateCartData + properties: + region_id: + type: string + title: region_id + description: The cart's region id. + customer_id: + type: string + title: customer_id + description: The cart's customer id. + sales_channel_id: + type: string + title: sales_channel_id + description: The cart's sales channel id. + email: + type: string + title: email + description: The cart's email. + format: email + currency_code: + type: string + title: currency_code + description: The cart's currency code. + shipping_address_id: + type: string + title: shipping_address_id + description: The cart's shipping address id. + billing_address_id: + type: string + title: billing_address_id + description: The cart's billing address id. + billing_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + shipping_address: + oneOf: + - $ref: '#/components/schemas/CreateAddress' + - $ref: '#/components/schemas/UpdateAddress' + metadata: + type: object + description: The cart's metadata. + UpdateOrderReturnReason: + type: object + description: SUMMARY + x-schemaName: UpdateOrderReturnReason + properties: + id: + type: string + title: id + description: The return reason's ID. + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata. diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml index e7588daca6..8284fa87c8 100644 --- a/www/apps/api-reference/specs/store/openapi.yaml +++ b/www/apps/api-reference/specs/store/openapi.yaml @@ -19,19 +19,21 @@ tags: description: How to implement cart functionality in your storefront url: >- https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart + - name: Collections - name: Currencies - name: Customers - description: > - A customer can register and manage their information such as addresses, - orders, payment methods, and more. - externalDocs: - description: How to implement customer profiles in your storefront - url: >- - https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles + - name: Orders - name: Payment Collections description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Payment Providers + - name: Product Categories + x-associatedSchema: + $ref: ./components/schemas/StoreProductCategory.yaml + - name: Products + x-associatedSchema: + $ref: ./components/schemas/StoreProduct.yaml - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -43,29 +45,30 @@ tags: description: How to use regions in a storefront url: >- https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + - name: Return + - name: Return Reasons - name: Shipping Options - description: > - A shipping option is used to define the available shipping methods during - checkout or when creating a return. - externalDocs: - description: Shipping Option architecture - url: >- - https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option paths: /store/carts: $ref: paths/store_carts.yaml /store/carts/{id}: $ref: paths/store_carts_{id}.yaml + /store/carts/{id}/complete: + $ref: paths/store_carts_{id}_complete.yaml /store/carts/{id}/line-items: $ref: paths/store_carts_{id}_line-items.yaml /store/carts/{id}/line-items/{line_id}: $ref: paths/store_carts_{id}_line-items_{line_id}.yaml - /store/carts/{id}/payment-collections: - $ref: paths/store_carts_{id}_payment-collections.yaml /store/carts/{id}/promotions: $ref: paths/store_carts_{id}_promotions.yaml + /store/carts/{id}/shipping-methods: + $ref: paths/store_carts_{id}_shipping-methods.yaml /store/carts/{id}/taxes: $ref: paths/store_carts_{id}_taxes.yaml + /store/collections: + $ref: paths/store_collections.yaml + /store/collections/{id}: + $ref: paths/store_collections_{id}.yaml /store/currencies: $ref: paths/store_currencies.yaml /store/currencies/{code}: @@ -78,16 +81,36 @@ paths: $ref: paths/store_customers_me_addresses.yaml /store/customers/me/addresses/{address_id}: $ref: paths/store_customers_me_addresses_{address_id}.yaml + /store/orders: + $ref: paths/store_orders.yaml + /store/orders/{id}: + $ref: paths/store_orders_{id}.yaml + /store/payment-collections: + $ref: paths/store_payment-collections.yaml /store/payment-collections/{id}/payment-sessions: $ref: paths/store_payment-collections_{id}_payment-sessions.yaml + /store/payment-providers: + $ref: paths/store_payment-providers.yaml + /store/product-categories: + $ref: paths/store_product-categories.yaml + /store/product-categories/{id}: + $ref: paths/store_product-categories_{id}.yaml + /store/products: + $ref: paths/store_products.yaml + /store/products/{id}: + $ref: paths/store_products_{id}.yaml /store/regions: $ref: paths/store_regions.yaml /store/regions/{id}: $ref: paths/store_regions_{id}.yaml - /store/regions/{id}/payment-providers: - $ref: paths/store_regions_{id}_payment-providers.yaml - /store/shipping-options/{cart_id}: - $ref: paths/store_shipping-options_{cart_id}.yaml + /store/return: + $ref: paths/store_return.yaml + /store/return-reasons: + $ref: paths/store_return-reasons.yaml + /store/return-reasons/{id}: + $ref: paths/store_return-reasons_{id}.yaml + /store/shipping-options: + $ref: paths/store_shipping-options.yaml components: securitySchemes: jwt_token: diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml index b3c9f70118..be90097716 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -3,7 +3,65 @@ post: summary: Create Cart description: Create a cart. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/CreateCartWorkflowInput.yaml x-codeSamples: - lang: Shell label: cURL @@ -12,6 +70,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -24,7 +84,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index 6c7ff10d87..52e3bc9a48 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -20,6 +73,8 @@ get: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -32,10 +87,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCartsId summary: Update a Cart @@ -48,6 +99,64 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/UpdateCartData.yaml x-codeSamples: - lang: Shell label: cURL @@ -56,6 +165,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -68,7 +179,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml new file mode 100644 index 0000000000..f31dced572 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml @@ -0,0 +1,98 @@ +post: + operationId: PostCartsIdComplete + summary: Add Completes to Cart + description: Add a list of completes to a cart. + x-authenticated: false + parameters: + - name: id + in: path + description: The cart's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + properties: + idempotency_key: + type: string + title: idempotency_key + description: The cart's idempotency key. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_carts_{id}_complete/post.sh + tags: + - Carts + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml index c821f142a0..7fe7235eb3 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml @@ -10,6 +10,64 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/StoreAddCartLineItem.yaml x-codeSamples: - lang: Shell label: cURL @@ -18,6 +76,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,7 +90,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index eb41b93406..566184dd07 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml @@ -16,6 +16,64 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/StoreUpdateCartLineItem.yaml x-codeSamples: - lang: Shell label: cURL @@ -24,6 +82,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -36,10 +96,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCartsIdLineItemsLine_id summary: Remove Line Items from Cart @@ -60,6 +116,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -68,6 +177,33 @@ delete: tags: - Carts responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - id + - object + - deleted + properties: + id: + type: string + title: id + description: The cart's ID. + object: + type: string + title: object + description: The cart's object. + deleted: + type: boolean + title: deleted + description: The cart's deleted. + parent: + type: object + description: The cart's parent. '400': $ref: ../components/responses/400_error.yaml '401': @@ -80,7 +216,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-collections.yaml deleted file mode 100644 index 29b29302ed..0000000000 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-collections.yaml +++ /dev/null @@ -1,36 +0,0 @@ -post: - operationId: PostCartsIdPaymentCollections - summary: Add Payment Collections to Cart - description: Add a list of payment collections to a cart. - x-authenticated: false - parameters: - - name: id - in: path - description: The cart's ID. - required: true - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/store_carts_{id}_payment-collections/post.sh - tags: - - Carts - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml index 9beb940ebd..ca0d6d9aaa 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml @@ -10,6 +10,75 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - promo_codes + properties: + promo_codes: + type: array + description: The cart's promo codes. + items: + type: string + title: promo_codes + description: The promo code's promo codes. x-codeSamples: - lang: Shell label: cURL @@ -18,6 +87,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -30,10 +101,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCartsIdPromotions summary: Remove Promotions from Cart @@ -48,6 +115,59 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -56,6 +176,8 @@ delete: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -68,7 +190,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml new file mode 100644 index 0000000000..eb18b11425 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml @@ -0,0 +1,103 @@ +post: + operationId: PostCartsIdShippingMethods + summary: Add Shipping Methods to Cart + description: Add a list of shipping methods to a cart. + x-authenticated: false + parameters: + - name: id + in: path + description: The cart's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - option_id + properties: + option_id: + type: string + title: option_id + description: The cart's option id. + data: + type: object + description: The cart's data. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_carts_{id}_shipping-methods/post.sh + tags: + - Carts + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml index b682bfc374..32124069d8 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml @@ -10,11 +10,64 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. requestBody: content: application/json: schema: - $ref: ../components/schemas/StorePostCartsCartTaxesReq.yaml + $ref: ../components/schemas/StoreCalculateCartTaxes.yaml x-codeSamples: - lang: Shell label: cURL @@ -23,6 +76,8 @@ post: tags: - Carts responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_collections.yaml b/www/apps/api-reference/specs/store/paths/store_collections.yaml new file mode 100644 index 0000000000..1cabde41c9 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -0,0 +1,83 @@ +get: + operationId: GetCollections + summary: List Collections + description: >- + Retrieve a list of collections. The collections can be filtered by fields + such as `id`. The collections can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_collections/get.sh + tags: + - Collections + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml new file mode 100644 index 0000000000..864721a32d --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml @@ -0,0 +1,89 @@ +get: + 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. + x-authenticated: false + parameters: + - name: id + in: path + description: The collection's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_collections_{id}/get.sh + tags: + - Collections + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_currencies.yaml b/www/apps/api-reference/specs/store/paths/store_currencies.yaml index 5a484b5f93..339e47f7ea 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -14,6 +67,8 @@ get: tags: - Currencies responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -26,7 +81,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml index b0e3329b16..0ed31d0e03 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -20,6 +73,8 @@ get: tags: - Currencies responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -32,7 +87,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index 26ff1861ee..25879e753b 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -3,7 +3,65 @@ post: summary: Create Customer description: Create a customer. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/StoreCreateCustomer.yaml x-codeSamples: - lang: Shell label: cURL @@ -12,6 +70,8 @@ post: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -24,7 +84,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml index f4fa33b2b6..71a987fb5d 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml @@ -4,8 +4,64 @@ get: description: >- Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL @@ -14,6 +70,8 @@ get: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -26,7 +84,92 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml +post: + operationId: PostCustomersMe + summary: Create Customer + description: Create a customer. + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] requestBody: content: application/json: - schema: {} + schema: + $ref: ../components/schemas/StoreUpdateCustomer.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_customers_me/post.sh + tags: + - Customers + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index d993417ab0..ed6143efd4 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml @@ -4,8 +4,175 @@ get: description: >- Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: metadata + in: query + description: The customer's metadata. + required: true + schema: + type: object + description: The customer's metadata. + - name: first_name + in: query + description: The customer's first name. + required: true + schema: + type: string + title: first_name + description: The customer's first name. + - name: last_name + in: query + description: The customer's last name. + required: true + schema: + type: string + title: last_name + description: The customer's last name. + - name: phone + in: query + description: The customer's phone. + required: true + schema: + type: string + title: phone + description: The customer's phone. + - name: company + in: query + description: The customer's company. + required: true + schema: + type: string + title: company + description: The customer's company. + - name: address_1 + in: query + description: The customer's address 1. + required: true + schema: + type: string + title: address_1 + description: The customer's address 1. + - name: address_2 + in: query + description: The customer's address 2. + required: true + schema: + type: string + title: address_2 + description: The customer's address 2. + - name: city + in: query + description: The customer's city. + required: true + schema: + type: string + title: city + description: The customer's city. + - name: country_code + in: query + description: The customer's country code. + required: true + schema: + type: string + title: country_code + description: The customer's country code. + - name: province + in: query + description: The customer's province. + required: true + schema: + type: string + title: province + description: The customer's province. + - name: postal_code + in: query + description: The customer's postal code. + required: true + schema: + type: string + title: postal_code + description: The customer's postal code. + - name: address_name + in: query + description: The customer's address name. + required: true + schema: + type: string + title: address_name + description: The customer's address name. + - name: is_default_shipping + in: query + description: The customer's is default shipping. + required: false + schema: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + - name: is_default_billing + in: query + description: The customer's is default billing. + required: false + schema: + type: boolean + title: is_default_billing + description: The customer's is default billing. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL @@ -14,6 +181,8 @@ get: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -26,16 +195,143 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersMeAddresses summary: Create Customer description: Create a customer. - x-authenticated: false - parameters: [] + x-authenticated: true + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - address_name + properties: + metadata: + type: object + description: The customer's metadata. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + company: + type: string + title: company + description: The customer's company. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. x-codeSamples: - lang: Shell label: cURL @@ -44,6 +340,8 @@ post: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -56,7 +354,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml index cd34e7826b..08f9431ea0 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml @@ -4,7 +4,7 @@ get: description: >- Retrieve a list of addresses in a customer. The addresses can be filtered by fields like FILTER FIELDS. The addresses can also be paginated. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -12,6 +12,62 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL @@ -20,6 +76,8 @@ get: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -32,15 +90,11 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} post: operationId: PostCustomersMeAddressesAddress_id summary: Add Addresses to Customer description: Add a list of addresses to a customer. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -48,6 +102,137 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - metadata + - first_name + - last_name + - phone + - company + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - address_name + properties: + metadata: + type: object + description: The customer's metadata. + first_name: + type: string + title: first_name + description: The customer's first name. + last_name: + type: string + title: last_name + description: The customer's last name. + phone: + type: string + title: phone + description: The customer's phone. + company: + type: string + title: company + description: The customer's company. + address_1: + type: string + title: address_1 + description: The customer's address 1. + address_2: + type: string + title: address_2 + description: The customer's address 2. + city: + type: string + title: city + description: The customer's city. + country_code: + type: string + title: country_code + description: The customer's country code. + province: + type: string + title: province + description: The customer's province. + postal_code: + type: string + title: postal_code + description: The customer's postal code. + address_name: + type: string + title: address_name + description: The customer's address name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: The customer's is default shipping. + is_default_billing: + type: boolean + title: is_default_billing + description: The customer's is default billing. x-codeSamples: - lang: Shell label: cURL @@ -57,6 +242,8 @@ post: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -69,17 +256,13 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteCustomersMeAddressesAddress_id summary: Remove Addresses from Customer description: >- Remove a list of addresses from a customer. This doesn't delete the Address, only the association between the Address and the customer. - x-authenticated: false + x-authenticated: true parameters: - name: address_id in: path @@ -87,6 +270,62 @@ delete: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + security: + - cookie_auth: [] + - jwt_token: [] x-codeSamples: - lang: Shell label: cURL @@ -96,6 +335,8 @@ delete: tags: - Customers responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -108,7 +349,3 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml new file mode 100644 index 0000000000..69ab0d1b34 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -0,0 +1,119 @@ +get: + operationId: GetOrders + summary: List Orders + description: >- + Retrieve a list of orders. The orders can be filtered by fields such as + `id`. The orders can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - 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: name + in: query + required: false + schema: + oneOf: + - type: string + title: name + description: The order's name. + - type: array + description: The order's name. + items: + type: string + title: name + description: The name's details. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_orders/get.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml new file mode 100644 index 0000000000..79d4d71ede --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -0,0 +1,125 @@ +get: + operationId: GetOrdersId + summary: Get a Order + description: >- + Retrieve a order by its ID. You can expand the order's relations or select + the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - 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: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_orders_{id}/get.sh + tags: + - Orders + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml new file mode 100644 index 0000000000..b7155c85d1 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml @@ -0,0 +1,109 @@ +post: + operationId: PostPaymentCollections + summary: Create Payment Collection + description: Create a payment collection. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - cart_id + - region_id + - currency_code + - amount + properties: + cart_id: + type: string + title: cart_id + description: The payment collection's cart id. + region_id: + type: string + title: region_id + description: The payment collection's region id. + currency_code: + type: string + title: currency_code + description: The payment collection's currency code. + amount: + type: number + title: amount + description: The payment collection's amount. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_payment-collections/post.sh + tags: + - Payment Collections + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml index b95d304101..782c0ada94 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml @@ -10,12 +10,78 @@ post: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. requestBody: content: application/json: schema: - $ref: >- - ../components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml + type: object + description: SUMMARY + required: + - provider_id + properties: + provider_id: + type: string + title: provider_id + description: The payment collection's provider id. + context: + type: object + description: The payment collection's context. + data: + type: object + description: The payment collection's data. x-codeSamples: - lang: Shell label: cURL @@ -25,6 +91,8 @@ post: tags: - Payment Collections responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml new file mode 100644 index 0000000000..9205038a46 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml @@ -0,0 +1,122 @@ +get: + operationId: GetPaymentProviders + summary: List Payment Providers + description: >- + Retrieve a list of payment providers. The payment providers can be filtered + by fields such as `id`. The payment providers can also be sorted or + paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: region_id + in: query + description: The payment provider's region id. + required: true + schema: + type: string + title: region_id + description: The payment provider's region id. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The payment provider's ID. + - type: array + description: The payment provider's ID. + items: + type: string + title: id + description: The id's ID. + - name: is_enabled + in: query + description: The payment provider's is enabled. + required: false + schema: + type: boolean + title: is_enabled + description: The payment provider's is enabled. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_payment-providers/get.sh + tags: + - Payment Providers + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml new file mode 100644 index 0000000000..065161335f --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml @@ -0,0 +1,275 @@ +get: + operationId: GetProductCategories + summary: List Product Categories + description: >- + Retrieve a list of product categories. The product categories can be + filtered by fields such as `id`. The product categories can also be sorted + or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: q + in: query + description: The product category's q. + required: false + schema: + type: string + title: q + description: The product category's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product category's ID. + - type: array + description: The product category's ID. + items: + type: string + title: id + description: The id's ID. + - name: description + in: query + required: false + schema: + oneOf: + - type: string + title: description + description: The product category's description. + - type: array + description: The product category's description. + items: + type: string + title: description + description: The description's details. + - name: handle + in: query + required: false + schema: + oneOf: + - type: string + title: handle + description: The product category's handle. + - type: array + description: The product category's handle. + items: + type: string + title: handle + description: The handle's details. + - name: parent_category_id + in: query + required: false + schema: + oneOf: + - type: string + title: parent_category_id + description: The product category's parent category id. + - type: array + description: The product category's parent category id. + items: + type: string + title: parent_category_id + description: The parent category id's details. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + - name: created_at + in: query + description: The product category's created at. + required: false + schema: + type: object + description: The product category's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product category's updated at. + required: false + schema: + type: object + description: The product category's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product category's deleted at. + required: false + schema: + type: object + description: The product category's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_product-categories/get.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreProductCategoryListResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml new file mode 100644 index 0000000000..16db47178a --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml @@ -0,0 +1,109 @@ +get: + operationId: GetProductCategoriesId + summary: Get a Product Category + description: >- + Retrieve a product category by its ID. You can expand the product category's + relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The product category's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: include_ancestors_tree + in: query + description: The product category's include ancestors tree. + required: true + schema: + type: boolean + title: include_ancestors_tree + description: The product category's include ancestors tree. + - name: include_descendants_tree + in: query + description: The product category's include descendants tree. + required: true + schema: + type: boolean + title: include_descendants_tree + description: The product category's include descendants tree. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_product-categories_{id}/get.sh + tags: + - Product Categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/StoreProductCategoryResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml new file mode 100644 index 0000000000..c1e4fe2b4a --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -0,0 +1,342 @@ +get: + operationId: GetProducts + summary: List Products + description: >- + Retrieve a list of products. The products can be filtered by fields such as + `id`. The products can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + - name: variants + in: query + description: The product's variants. + required: false + schema: + type: object + description: The product's variants. + properties: + status: + type: array + description: The variant's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + options: + type: object + description: The variant's options. + required: + - value + - option_id + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's option id. + $and: {} + $or: {} + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + description: The product's title. + required: true + schema: + type: string + title: title + description: The product's title. + - name: handle + in: query + description: The product's handle. + required: true + schema: + type: string + title: handle + description: The product's handle. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: true + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: category_id + in: query + description: The product's category id. + required: true + schema: + type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - name: sales_channel_id + in: query + description: The product's sales channel id. + required: true + schema: + type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: collection_id + in: query + description: The product's collection id. + required: true + schema: + type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: array + description: The product's tags. + items: + type: string + title: tags + description: The tag's tags. + - name: type_id + in: query + description: The product's type id. + required: false + schema: + type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_products/get.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml new file mode 100644 index 0000000000..de49050cc7 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml @@ -0,0 +1,348 @@ +get: + operationId: GetProductsId + summary: Get a Product + description: >- + Retrieve a product by its ID. You can expand the product's relations or + select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The product's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + - name: currency_code + in: query + description: The product's currency code. + required: false + schema: + type: string + title: currency_code + description: The product's currency code. + - name: region_id + in: query + description: The product's region id. + required: false + schema: + type: string + title: region_id + description: The product's region id. + - name: $and + in: query + required: false + schema: {} + - name: $or + in: query + required: false + schema: {} + - name: variants + in: query + description: The product's variants. + required: false + schema: + type: object + description: The product's variants. + properties: + status: + type: array + description: The variant's status. + items: + type: string + enum: + - draft + - proposed + - published + - rejected + options: + type: object + description: The variant's options. + required: + - value + - option_id + properties: + value: + type: string + title: value + description: The option's value. + option_id: + type: string + title: option_id + description: The option's option id. + $and: {} + $or: {} + - name: q + in: query + description: The product's q. + required: false + schema: + type: string + title: q + description: The product's q. + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The product's ID. + - type: array + description: The product's ID. + items: + type: string + title: id + description: The id's ID. + - name: title + in: query + description: The product's title. + required: true + schema: + type: string + title: title + description: The product's title. + - name: handle + in: query + description: The product's handle. + required: true + schema: + type: string + title: handle + description: The product's handle. + - name: is_giftcard + in: query + description: The product's is giftcard. + required: true + schema: + type: boolean + title: is_giftcard + description: The product's is giftcard. + - name: category_id + in: query + description: The product's category id. + required: true + schema: + type: array + description: The product's category id. + items: + type: string + title: category_id + description: The category id's details. + - name: sales_channel_id + in: query + description: The product's sales channel id. + required: true + schema: + type: array + description: The product's sales channel id. + items: + type: string + title: sales_channel_id + description: The sales channel id's details. + - name: collection_id + in: query + description: The product's collection id. + required: true + schema: + type: array + description: The product's collection id. + items: + type: string + title: collection_id + description: The collection id's details. + - name: tags + in: query + description: The product's tags. + required: false + schema: + type: array + description: The product's tags. + items: + type: string + title: tags + description: The tag's tags. + - name: type_id + in: query + description: The product's type id. + required: false + schema: + type: array + description: The product's type id. + items: + type: string + title: type_id + description: The type id's details. + - name: created_at + in: query + description: The product's created at. + required: false + schema: + type: object + description: The product's created at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: updated_at + in: query + description: The product's updated at. + required: false + schema: + type: object + description: The product's updated at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + - name: deleted_at + in: query + description: The product's deleted at. + required: false + schema: + type: object + description: The product's deleted at. + required: + - $eq + - $ne + - $in + - $nin + - $like + - $ilike + - $re + - $contains + - $gt + - $gte + - $lt + - $lte + properties: + $eq: {} + $ne: {} + $in: {} + $nin: {} + $like: {} + $ilike: {} + $re: {} + $contains: {} + $gt: {} + $gte: {} + $lt: {} + $lte: {} + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_products_{id}/get.sh + tags: + - Products + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_regions.yaml b/www/apps/api-reference/specs/store/paths/store_regions.yaml index d360b3398d..ccc715c523 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -5,7 +5,60 @@ get: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. x-authenticated: false - parameters: [] + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -14,6 +67,8 @@ get: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -26,7 +81,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml index 8c726fd014..e3358146f6 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml @@ -12,6 +12,59 @@ get: required: true schema: type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. x-codeSamples: - lang: Shell label: cURL @@ -20,6 +73,8 @@ get: tags: - Regions responses: + '200': + description: OK '400': $ref: ../components/responses/400_error.yaml '401': @@ -32,7 +87,3 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_regions_{id}_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}_payment-providers.yaml deleted file mode 100644 index 50e9d33a31..0000000000 --- a/www/apps/api-reference/specs/store/paths/store_regions_{id}_payment-providers.yaml +++ /dev/null @@ -1,39 +0,0 @@ -get: - operationId: GetRegionsIdPaymentProviders - summary: List Payment Providers - description: >- - Retrieve a list of payment providers in a region. The payment providers can - be filtered by fields like FILTER FIELDS. The payment providers can also be - paginated. - x-authenticated: false - parameters: - - name: id - in: path - description: The region's ID. - required: true - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/store_regions_{id}_payment-providers/get.sh - tags: - - Regions - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml new file mode 100644 index 0000000000..5ec7e4511d --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml @@ -0,0 +1,83 @@ +get: + operationId: GetReturnReasons + summary: List Return Reasons + description: >- + Retrieve a list of return reasons. The return reasons can be filtered by + fields such as `id`. The return reasons can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_return-reasons/get.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml new file mode 100644 index 0000000000..56b12ab55b --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml @@ -0,0 +1,89 @@ +get: + operationId: GetReturnReasonsId + summary: Get a Return Reason + description: >- + Retrieve a return reason by its ID. You can expand the return reason's + relations or select the fields that should be returned. + x-authenticated: false + parameters: + - name: id + in: path + description: The return reason's ID. + required: true + schema: + type: string + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_return-reasons_{id}/get.sh + tags: + - Return Reasons + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_return.yaml b/www/apps/api-reference/specs/store/paths/store_return.yaml new file mode 100644 index 0000000000..05e55a5231 --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_return.yaml @@ -0,0 +1,86 @@ +post: + operationId: PostReturn + summary: Create Return + description: Create a return. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/StorePostReturnsReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_return/post.sh + tags: + - Return + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml new file mode 100644 index 0000000000..f0ede2b15d --- /dev/null +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml @@ -0,0 +1,83 @@ +get: + operationId: GetShippingOptions + summary: List Shipping Options + description: >- + Retrieve a list of shipping options. The shipping options can be filtered by + fields such as `id`. The shipping options can also be sorted or paginated. + x-authenticated: false + parameters: + - name: expand + in: query + description: Comma-separated relations that should be expanded in the returned data. + required: false + schema: + type: string + title: expand + description: >- + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + required: false + schema: + type: string + title: fields + description: |- + Comma-separated fields that should be included in the returned data. + * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * without prefix it will replace the entire default fields. + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + - name: order + in: query + description: >- + The field to sort the data by. By default, the sort order is ascending. + To change the order to descending, prefix the field name with `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/store_shipping-options/get.sh + tags: + - Shipping Options + responses: + '200': + description: OK + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml deleted file mode 100644 index 6d78928e6f..0000000000 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml +++ /dev/null @@ -1,38 +0,0 @@ -get: - operationId: GetShippingOptionsCart_id - summary: Get a Shipping Option - description: >- - Retrieve a shipping option by its ID. You can expand the shipping option's - relations or select the fields that should be returned. - x-authenticated: false - parameters: - - name: cart_id - in: path - description: The shipping option's cart id. - required: true - schema: - type: string - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: ../code_samples/Shell/store_shipping-options_{cart_id}/get.sh - tags: - - Shipping Options - responses: - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} diff --git a/www/utils/generated/oas-output/base/admin.oas.base.yaml b/www/utils/generated/oas-output/base/admin.oas.base.yaml index 2c989226bb..c996cdf036 100644 --- a/www/utils/generated/oas-output/base/admin.oas.base.yaml +++ b/www/utils/generated/oas-output/base/admin.oas.base.yaml @@ -9,6 +9,8 @@ tags: - name: Api Keys - name: Campaigns - name: Collections + x-associatedSchema: + $ref: "#/components/schemas/AdminCollection" - name: Currencies description: > A store can use unlimited currencies, and each region must be associated @@ -19,6 +21,8 @@ tags: description: How to manage currencies url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies - name: Customer Groups + x-associatedSchema: + $ref: "#/components/schemas/AdminCustomerGroup" - name: Customers description: > Customers can either be created when they register through the Store APIs, @@ -26,9 +30,15 @@ tags: externalDocs: description: How to manage customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers + x-associatedSchema: + $ref: "#/components/schemas/AdminCustomer" - name: Draft Orders - name: Fulfillment Providers + x-associatedSchema: + $ref: "#/components/schemas/AdminFulfillmentProvider" - name: Fulfillment Sets + x-associatedSchema: + $ref: "#/components/schemas/AdminFulfillmentSet" - name: Fulfillments - name: Inventory Items - name: Invites @@ -41,13 +51,15 @@ tags: - name: Orders - name: Payments - name: Price Lists - - name: Pricing - name: Product Categories + x-associatedSchema: + $ref: "#/components/schemas/AdminProductCategory" + - name: Product Tags - name: Product Types - name: Products - - name: Promotions x-associatedSchema: - $ref: "#/components/schemas/Promotion" + $ref: "#/components/schemas/AdminProduct" + - name: Promotions - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -58,6 +70,8 @@ tags: description: How to manage regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions - name: Reservations + - name: Return Reasons + - name: Returns - name: Sales Channels description: > A sales channel indicates a channel where products can be sold in. For @@ -67,8 +81,14 @@ tags: externalDocs: description: How to manage sales channels url: https://docs.medusajs.com/modules/sales-channels/admin/manage + x-associatedSchema: + $ref: "#/components/schemas/AdminSalesChannel" - name: Shipping Options + x-associatedSchema: + $ref: "#/components/schemas/AdminShippingOption" - name: Shipping Profiles + x-associatedSchema: + $ref: "#/components/schemas/AdminShippingProfile" - name: Stock Locations - name: Stores - name: Tax Rates diff --git a/www/utils/generated/oas-output/base/store.oas.base.yaml b/www/utils/generated/oas-output/base/store.oas.base.yaml index c296a64b93..8db9069e9d 100644 --- a/www/utils/generated/oas-output/base/store.oas.base.yaml +++ b/www/utils/generated/oas-output/base/store.oas.base.yaml @@ -18,12 +18,18 @@ tags: - name: Collections - name: Currencies - name: Customers + - name: Orders - name: Payment Collections description: > A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments. + - name: Payment Providers - name: Product Categories + x-associatedSchema: + $ref: "#/components/schemas/StoreProductCategory" - name: Products + x-associatedSchema: + $ref: "#/components/schemas/StoreProduct" - name: Regions description: > Regions are different countries or geographical regions that the commerce @@ -33,6 +39,8 @@ tags: externalDocs: description: How to use regions in a storefront url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions + - name: Return + - name: Return Reasons - name: Shipping Options servers: - url: http://localhost:9000 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts index 3abdbe40f0..8d65f3eedf 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts index 748cbad169..47235c485b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts index 780f80274e..139e033ded 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts index d031227e90..6c64b8a522 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts index aecb556896..3e155e8610 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 27de00a927..1e0fdf347e 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,6 +83,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -85,10 +97,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts index d89ce6ddec..3f7a86f6c1 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -69,7 +79,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminFulfillmentSetsDeleteResponse" + * $ref: "#/components/schemas/AdminFulfillmentSetDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -82,10 +92,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 4367bf2299..42d83cb80a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -29,12 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -53,12 +59,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,10 +86,6 @@ * responses: * "200": * description: OK - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminServiceZoneDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -92,10 +98,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts index 2fb2fe4f4b..c3ec4a13cf 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 37627f876c..081ac04905 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -29,12 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -53,12 +59,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -74,6 +84,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -86,10 +98,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts index c28fa95452..b36cf22358 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts @@ -3,7 +3,7 @@ * operationId: DeleteInvitesId * summary: Delete a Invite * description: Delete a invite. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl -X DELETE '{backend_url}/admin/invites/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl -X DELETE '{backend_url}/admin/invites/{id}' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +82,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts index 9eaf720154..804e94e05a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_price-lists_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts new file mode 100644 index 0000000000..a18a5649ee --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-categories_[id].ts @@ -0,0 +1,93 @@ +/** + * @oas [delete] /admin/product-categories/{id} + * operationId: DeleteProductCategoriesId + * summary: Delete a Product Category + * description: Delete a product category. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product category's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/product-categories/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Categories + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts similarity index 58% rename from www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts rename to www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts index cf46699bb5..c4348e3593 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-tags_[id].ts @@ -1,14 +1,13 @@ /** - * @oas [get] /admin/pricing/rule-types/{id} - * operationId: GetPricingRuleTypesId - * summary: List Rule Types - * description: Retrieve a list of rule types in a pricing. The rule types can be - * filtered by fields like FILTER FIELDS. The rule types can also be paginated. + * @oas [delete] /admin/product-tags/{id} + * operationId: DeleteProductTagsId + * summary: Delete a Product Tag + * description: Delete a product tag. * x-authenticated: true * parameters: * - name: id * in: path - * description: The pricing's ID. + * description: The product tag's ID. * required: true * schema: * type: string @@ -22,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,38 +51,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * properties: - * fields: - * type: string - * title: fields - * description: The pricing's fields. - * required: - * - fields * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl '{backend_url}/admin/pricing/rule-types/{id}' \ + * curl -X DELETE '{backend_url}/admin/product-tags/{id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: - * - Pricing + * - Product Tags * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts index 217cb37e13..e1aa1a93cd 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_product-types_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Product Types * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts index 9bcdf2ac54..7c23653c92 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +92,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts index 6bda250d2c..a7b2ec3410 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductOptionDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts index 5b8a73b64c..d60ba03416 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantDeleteResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts new file mode 100644 index 0000000000..2e0cdc7790 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -0,0 +1,110 @@ +/** + * @oas [delete] /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id} + * operationId: DeleteProductsIdVariantsVariant_idInventoryItemsInventory_item_id + * summary: Remove Inventory Items from Product + * description: Remove a list of inventory items from a product. This doesn't + * delete the Inventory Item, only the association between the Inventory Item and + * the product. + * 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's variant id. + * required: true + * schema: + * type: string + * - name: inventory_item_id + * in: path + * description: The product's inventory item id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X DELETE + * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts index 5a869ae239..4749aeb60f 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_promotions_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts index c2bd70fb29..edd11312e0 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_regions_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts index 2d675a927a..c049b51dfd 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_reservations_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Reservations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts new file mode 100644 index 0000000000..aea72850fd --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_return-reasons_[id].ts @@ -0,0 +1,93 @@ +/** + * @oas [delete] /admin/return-reasons/{id} + * operationId: DeleteReturnReasonsId + * summary: Delete a Return Reason + * description: Delete a return reason. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X DELETE '{backend_url}/admin/return-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Return Reasons + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts index f1aec0491a..0f1387da83 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_sales-channels_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts index f46248fb4d..9537cd11f2 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-options_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,10 +92,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts index 4765157bca..04fb75233d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -82,10 +92,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts index 661e54668a..6280ee362c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_stock-locations_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts index 88e55f1ffc..fb1fb582e3 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index 7a9b3cf518..547788481c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,8 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +95,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts index 6167b913fe..5425848347 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-regions_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts index df5a5569f7..fcc5647c6a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_uploads_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,6 +74,8 @@ * tags: * - Uploads * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts index 3eab291d9b..7af26d3808 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_users_[id].ts @@ -3,7 +3,7 @@ * operationId: DeleteUsersId * summary: Delete a User * description: Delete a user. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl -X DELETE '{backend_url}/admin/users/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl -X DELETE '{backend_url}/admin/users/{id}' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +82,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts index b0fe3c6a6a..ef2936bfc2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts index 1273ff70f8..9357bb61a1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index eb8477dea9..1e3f79efbc 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts index 29681ce0fe..04aa083aa4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Campaigns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts index dd74996472..b80563b3a2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts index b885d1c610..356cb28e1c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts index 24e1e5446c..8cd75f539e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Currencies * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts index 3dfee69a65..48ee781781 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Currencies * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts index 9d94241929..235167e011 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -60,6 +70,8 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -72,10 +84,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts index fa88b8d527..1725692d03 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index ddf042cb0b..c49b6c592f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -64,7 +74,33 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCustomerListResponse" + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The customer's limit. + * offset: + * type: number + * title: offset + * description: The customer's offset. + * count: + * type: number + * title: count + * description: The customer's count. + * - type: object + * description: SUMMARY + * required: + * - customers + * properties: + * customers: + * $ref: "#/components/schemas/AdminCustomer" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +113,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index fe55fe6706..f370a88ab7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -70,7 +80,13 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCustomerResponse" + * type: object + * description: SUMMARY + * required: + * - customer + * properties: + * customer: + * $ref: "#/components/schemas/AdminCustomer" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 6e4505a91b..10ea2e6bc7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index a49b2b2fbb..2f59ef91fe 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +95,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index f7935c30b1..38f3bf4cbe 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts index 9a671da8f6..1d49b90e12 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index 150bff8def..7f8713bca7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,42 +47,61 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The fulfillment provider's ID. + * - type: array + * description: The fulfillment provider's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: is_enabled + * in: query + * description: The fulfillment provider's is enabled. + * required: true + * schema: + * type: boolean + * title: is_enabled + * description: The fulfillment provider's is enabled. + * - name: q + * in: query + * description: The fulfillment provider's q. + * required: false + * schema: + * type: string + * title: q + * description: The fulfillment provider's q. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The fulfillment provider's fields. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/fulfillment-providers' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Fulfillment Providers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 49b9f9adca..539f393359 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -29,12 +29,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -53,12 +59,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -90,10 +100,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index 0bb021c6c9..4c569b41ca 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,275 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The inventory item's q. + * required: false + * schema: + * type: string + * title: q + * description: The inventory item's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The inventory item's ID. + * - type: array + * description: The inventory item's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: sku + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: sku + * description: The inventory item's sku. + * - type: array + * description: The inventory item's sku. + * items: + * type: string + * title: sku + * description: The sku's details. + * - name: origin_country + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: origin_country + * description: The inventory item's origin country. + * - type: array + * description: The inventory item's origin country. + * items: + * type: string + * title: origin_country + * description: The origin country's details. + * - name: mid_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: mid_code + * description: The inventory item's mid code. + * - type: array + * description: The inventory item's mid code. + * items: + * type: string + * title: mid_code + * description: The mid code's details. + * - name: hs_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: hs_code + * description: The inventory item's hs code. + * - type: array + * description: The inventory item's hs code. + * items: + * type: string + * title: hs_code + * description: The hs code's details. + * - name: material + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: material + * description: The inventory item's material. + * - type: array + * description: The inventory item's material. + * items: + * type: string + * title: material + * description: The material's details. + * - name: requires_shipping + * in: query + * description: The inventory item's requires shipping. + * required: true + * schema: + * type: boolean + * title: requires_shipping + * description: The inventory item's requires shipping. + * - name: weight + * in: query + * description: The inventory item's weight. + * required: false + * schema: + * type: object + * description: The inventory item's weight. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: length + * in: query + * description: The inventory item's length. + * required: false + * schema: + * type: object + * description: The inventory item's length. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: height + * in: query + * description: The inventory item's height. + * required: false + * schema: + * type: object + * description: The inventory item's height. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: width + * in: query + * description: The inventory item's width. + * required: false + * schema: + * type: object + * description: The inventory item's width. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: location_levels + * in: query + * description: The inventory item's location levels. + * required: false + * schema: + * type: object + * description: The inventory item's location levels. + * properties: + * location_id: + * oneOf: + * - type: string + * title: location_id + * description: The location level's location id. + * - type: array + * description: The location level's location id. + * items: + * type: string + * title: location_id + * description: The location id's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -60,6 +329,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -72,10 +343,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts index 08c6c5250b..488c300f2d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The inventory item's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index 25ab201e3e..cdb222c3ea 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -23,12 +23,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,12 +53,38 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: location_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: location_id + * description: The inventory item's location id. + * - type: array + * description: The inventory item's location id. + * items: + * type: string + * title: location_id + * description: The location id's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -66,6 +98,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -78,10 +112,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index f6f54520f2..2c70fbb881 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -4,7 +4,7 @@ * summary: List Invites * description: Retrieve a list of invites. The invites can be filtered by fields * such as `id`. The invites can also be sorted or paginated. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,25 +46,170 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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: The invite's q. + * required: false + * schema: + * type: string + * title: q + * description: The invite's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The invite's ID. + * - type: array + * description: The invite's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: email + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: email + * description: The invite's email. + * format: email + * - type: array + * description: The invite's email. + * items: + * type: string + * title: email + * description: The email's details. + * format: email + * - name: created_at + * in: query + * description: The invite's created at. + * required: false + * schema: + * type: object + * description: The invite's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The invite's updated at. + * required: false + * schema: + * type: object + * description: The invite's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The invite's deleted at. + * required: false + * schema: + * type: object + * description: The invite's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/admin/invites' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl '{backend_url}/admin/invites' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +222,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts index 8dc7f82de4..dbd06205ac 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts @@ -4,7 +4,7 @@ * summary: Get a Invite * description: Retrieve a invite by its ID. You can expand the invite's relations * or select the fields that should be returned. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,25 +52,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/admin/invites/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl '{backend_url}/admin/invites/{id}' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index af825f9ab9..7cb4e6b9fe 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index a0735c2b47..8ca102d4d0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index 428310573d..11dfc714e7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,159 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The payment's q. + * required: false + * schema: + * type: string + * title: q + * description: The payment's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The payment's ID. + * - type: array + * description: The payment's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: payment_session_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: payment_session_id + * description: The payment's payment session id. + * - type: array + * description: The payment's payment session id. + * items: + * type: string + * title: payment_session_id + * description: The payment session id's details. + * - name: created_at + * in: query + * description: The payment's created at. + * required: false + * schema: + * type: object + * description: The payment's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The payment's updated at. + * required: false + * schema: + * type: object + * description: The payment's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The payment's deleted at. + * required: false + * schema: + * type: object + * description: The payment's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +212,8 @@ * tags: * - Payments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +226,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts index 529218c00e..92ced28f65 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Payments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The payment's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index dea960f138..95059152ba 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,46 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The payment's ID. + * - type: array + * description: The payment's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: is_enabled + * in: query + * description: The payment's is enabled. + * required: false + * schema: + * type: boolean + * title: is_enabled + * description: The payment's is enabled. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +99,8 @@ * tags: * - Payments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +113,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts index 2f879f3d89..dc42793f31 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +69,8 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts index 35a90b52df..3b878b6ab7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 48111ceb09..909ab87288 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,219 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The product category's q. + * required: false + * schema: + * type: string + * title: q + * description: The product category's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product category's ID. + * - type: array + * description: The product category's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: description + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: description + * description: The product category's description. + * - type: array + * description: The product category's description. + * items: + * type: string + * title: description + * description: The description's details. + * - name: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: The product category's handle. + * - type: array + * description: The product category's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * - name: parent_category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: parent_category_id + * description: The product category's parent category id. + * - type: array + * description: The product category's parent category id. + * items: + * type: string + * title: parent_category_id + * description: The parent category id's details. + * - name: include_ancestors_tree + * in: query + * description: The product category's include ancestors tree. + * required: true + * schema: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * - name: include_descendants_tree + * in: query + * description: The product category's include descendants tree. + * required: true + * schema: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. + * - name: is_internal + * in: query + * description: The product category's is internal. + * required: true + * schema: + * type: boolean + * title: is_internal + * description: The product category's is internal. + * - name: is_active + * in: query + * description: The product category's is active. + * required: true + * schema: + * type: boolean + * title: is_active + * description: The product category's is active. + * - name: created_at + * in: query + * description: The product category's created at. + * required: false + * schema: + * type: object + * description: The product category's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product category's updated at. + * required: false + * schema: + * type: object + * description: The product category's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product category's deleted at. + * required: false + * schema: + * type: object + * description: The product category's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -78,10 +291,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index 75e5b06c71..39639ded4e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,51 +52,42 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: include_ancestors_tree + * in: query + * description: The product category's include ancestors tree. + * required: true + * schema: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * - name: include_descendants_tree + * in: query + * description: The product category's include descendants tree. + * required: true + * schema: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * - include_ancestors_tree - * - include_descendants_tree - * properties: - * fields: - * type: string - * title: fields - * description: The product category's fields. - * include_ancestors_tree: - * type: boolean - * title: include_ancestors_tree - * description: The product category's include ancestors tree. - * include_descendants_tree: - * type: boolean - * title: include_descendants_tree - * description: The product category's include descendants tree. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/product-categories/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}", - * "include_ancestors_tree": true, - * "include_descendants_tree": true - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Product Categories * responses: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts new file mode 100644 index 0000000000..a3b76b32a2 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -0,0 +1,231 @@ +/** + * @oas [get] /admin/product-tags + * operationId: GetProductTags + * summary: List Product Tags + * description: Retrieve a list of product tags. The product tags can be filtered + * by fields such as `id`. The product tags can also be sorted or paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * - name: q + * in: query + * description: The product tag's q. + * required: false + * schema: + * type: string + * title: q + * description: The product tag's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product tag's ID. + * - type: array + * description: The product tag's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: value + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: value + * description: The product tag's value. + * - type: array + * description: The product tag's value. + * items: + * type: string + * title: value + * description: The value's details. + * - name: created_at + * in: query + * description: The product tag's created at. + * required: false + * schema: + * type: object + * description: The product tag's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product tag's updated at. + * required: false + * schema: + * type: object + * description: The product tag's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product tag's deleted at. + * required: false + * schema: + * type: object + * description: The product tag's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-tags' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Tags + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts new file mode 100644 index 0000000000..3102cd9e84 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts @@ -0,0 +1,94 @@ +/** + * @oas [get] /admin/product-tags/{id} + * operationId: GetProductTagsId + * summary: Get a Product Tag + * description: Retrieve a product tag by its ID. You can expand the product tag's + * relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product tag's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/product-tags/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Product Tags + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index 3d688f4371..0a35604e0c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,159 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The product type's q. + * required: false + * schema: + * type: string + * title: q + * description: The product type's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product type's ID. + * - type: array + * description: The product type's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: value + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: value + * description: The product type's value. + * - type: array + * description: The product type's value. + * items: + * type: string + * title: value + * description: The value's details. + * - name: created_at + * in: query + * description: The product type's created at. + * required: false + * schema: + * type: object + * description: The product type's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product type's updated at. + * required: false + * schema: + * type: object + * description: The product type's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product type's deleted at. + * required: false + * schema: + * type: object + * description: The product type's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +212,8 @@ * tags: * - Product Types * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +226,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts index 0a601f0f63..32f23a05bf 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,42 +52,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The product type's fields. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/product-types/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Product Types * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index 47ee6c2cb3..09386fe172 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,13932 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: price_list_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: price_list_id + * description: The product's price list id. + * - type: array + * description: The product's price list id. + * items: + * type: string + * title: price_list_id + * description: The price list id's details. + * - name: q + * in: query + * description: The product's q. + * required: false + * schema: + * type: string + * title: q + * description: The product's q. + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: string + * title: status + * description: The product's status. + * - type: array + * description: The product's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * - name: sales_channel_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The product's sales channel id. + * - type: array + * description: The product's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * - name: title + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: title + * description: The product's title. + * - type: array + * description: The product's title. + * items: + * type: string + * title: title + * description: The title's details. + * - name: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: The product's handle. + * - type: array + * description: The product's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: is_giftcard + * in: query + * description: The product's is giftcard. + * required: false + * schema: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * - name: tags + * in: query + * description: The product's tags. + * required: false + * schema: + * type: object + * description: The product's tags. + * properties: + * value: + * type: array + * description: The tag's value. + * items: + * type: string + * title: value + * description: The value's details. + * - name: type_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: type_id + * description: The product's type id. + * - type: array + * description: The product's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * - name: category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: category_id + * description: The product's category id. + * - type: array + * description: The product's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The product's category id. + * properties: + * $and: + * type: array + * description: The category id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * $or: + * type: array + * description: The category id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The category id's $eq. + * - type: object + * description: The category id's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * - type: array + * description: The category id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The category id's $ne. + * - type: object + * description: The category id's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1128: + * type: object + * description: The $ne's @match@1128. + * __@replace@1130: + * type: object + * description: The $ne's @replace@1130. + * __@search@1133: + * type: object + * description: The $ne's @search@1133. + * __@split@1135: + * type: object + * description: The $ne's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $ne's @matchall@1137. + * $in: + * type: array + * description: The category id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1128: + * type: object + * description: The $in's @match@1128. + * __@replace@1130: + * type: object + * description: The $in's @replace@1130. + * __@search@1133: + * type: object + * description: The $in's @search@1133. + * __@split@1135: + * type: object + * description: The $in's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $in's @matchall@1137. + * $nin: + * type: array + * description: The category id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1128: + * type: object + * description: The $nin's @match@1128. + * __@replace@1130: + * type: object + * description: The $nin's @replace@1130. + * __@search@1133: + * type: object + * description: The $nin's @search@1133. + * __@split@1135: + * type: object + * description: The $nin's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $nin's @matchall@1137. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The category id's $not. + * - type: object + * description: The category id's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * - type: object + * description: The category id's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The category id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The category id's $gt. + * - type: object + * description: The category id's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1128: + * type: object + * description: The $gt's @match@1128. + * __@replace@1130: + * type: object + * description: The $gt's @replace@1130. + * __@search@1133: + * type: object + * description: The $gt's @search@1133. + * __@split@1135: + * type: object + * description: The $gt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gt's @matchall@1137. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The category id's $gte. + * - type: object + * description: The category id's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1128: + * type: object + * description: The $gte's @match@1128. + * __@replace@1130: + * type: object + * description: The $gte's @replace@1130. + * __@search@1133: + * type: object + * description: The $gte's @search@1133. + * __@split@1135: + * type: object + * description: The $gte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gte's @matchall@1137. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The category id's $lt. + * - type: object + * description: The category id's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1128: + * type: object + * description: The $lt's @match@1128. + * __@replace@1130: + * type: object + * description: The $lt's @replace@1130. + * __@search@1133: + * type: object + * description: The $lt's @search@1133. + * __@split@1135: + * type: object + * description: The $lt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lt's @matchall@1137. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The category id's $lte. + * - type: object + * description: The category id's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1128: + * type: object + * description: The $lte's @match@1128. + * __@replace@1130: + * type: object + * description: The $lte's @replace@1130. + * __@search@1133: + * type: object + * description: The $lte's @search@1133. + * __@split@1135: + * type: object + * description: The $lte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lte's @matchall@1137. + * $like: + * type: string + * title: $like + * description: The category id's $like. + * $re: + * type: string + * title: $re + * description: The category id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The category id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The category id's $fulltext. + * $overlap: + * type: array + * description: The category id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The category id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The category id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The category id's $exists. + * - name: categories + * in: query + * required: false + * schema: + * oneOf: + * - type: object + * description: The product's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * properties: + * $and: + * type: array + * description: The id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The id's $eq. + * - type: object + * description: The id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The id's $ne. + * - type: object + * description: The id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The id's $not. + * - type: object + * description: The id's $not. + * x-schemaName: RegExp + * - type: object + * description: The id's $not. + * - type: array + * description: The id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The id's $gt. + * - type: object + * description: The id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The id's $gte. + * - type: object + * description: The id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The id's $lt. + * - type: object + * description: The id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The id's $lte. + * - type: object + * description: The id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The id's $like. + * $re: + * type: string + * title: $re + * description: The id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The id's $fulltext. + * $overlap: + * type: array + * description: The id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The id's $exists. + * - type: object + * description: The product's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * properties: + * $and: + * type: array + * description: The id's $and. + * items: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The id's $or. + * items: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * $eq: + * oneOf: + * - type: array + * description: The id's $eq. + * items: + * type: string + * title: $eq + * description: The $eq's details. + * - type: array + * description: The id's $eq. + * items: + * type: array + * description: The $eq's details. + * items: + * type: string + * title: $eq + * description: The $eq's details. + * $ne: + * type: array + * description: The id's $ne. + * items: + * type: string + * title: $ne + * description: The $ne's details. + * $in: + * type: array + * description: The id's $in. + * items: + * type: array + * description: The $in's details. + * items: + * type: string + * title: $in + * description: The $in's details. + * $nin: + * type: array + * description: The id's $nin. + * items: + * type: array + * description: The $nin's details. + * items: + * type: string + * title: $nin + * description: The $nin's details. + * $not: + * type: array + * description: The id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * $gt: + * type: array + * description: The id's $gt. + * items: + * type: string + * title: $gt + * description: The $gt's details. + * $gte: + * type: array + * description: The id's $gte. + * items: + * type: string + * title: $gte + * description: The $gte's details. + * $lt: + * type: array + * description: The id's $lt. + * items: + * type: string + * title: $lt + * description: The $lt's details. + * $lte: + * type: array + * description: The id's $lte. + * items: + * type: string + * title: $lte + * description: The $lte's details. + * $like: + * type: string + * title: $like + * description: The id's $like. + * $re: + * type: string + * title: $re + * description: The id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The id's $fulltext. + * $overlap: + * type: array + * description: The id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The id's $exists. + * - name: collection_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: collection_id + * description: The product's collection id. + * - type: array + * description: The product's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The product's collection id. + * properties: + * $and: + * type: array + * description: The collection id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * $or: + * type: array + * description: The collection id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The collection id's $eq. + * - type: object + * description: The collection id's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * - type: array + * description: The collection id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The collection id's $ne. + * - type: object + * description: The collection id's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1128: + * type: object + * description: The $ne's @match@1128. + * __@replace@1130: + * type: object + * description: The $ne's @replace@1130. + * __@search@1133: + * type: object + * description: The $ne's @search@1133. + * __@split@1135: + * type: object + * description: The $ne's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $ne's @matchall@1137. + * $in: + * type: array + * description: The collection id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1128: + * type: object + * description: The $in's @match@1128. + * __@replace@1130: + * type: object + * description: The $in's @replace@1130. + * __@search@1133: + * type: object + * description: The $in's @search@1133. + * __@split@1135: + * type: object + * description: The $in's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $in's @matchall@1137. + * $nin: + * type: array + * description: The collection id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1128: + * type: object + * description: The $nin's @match@1128. + * __@replace@1130: + * type: object + * description: The $nin's @replace@1130. + * __@search@1133: + * type: object + * description: The $nin's @search@1133. + * __@split@1135: + * type: object + * description: The $nin's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $nin's @matchall@1137. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The collection id's $not. + * - type: object + * description: The collection id's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * - type: object + * description: The collection id's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The collection id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The collection id's $gt. + * - type: object + * description: The collection id's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1128: + * type: object + * description: The $gt's @match@1128. + * __@replace@1130: + * type: object + * description: The $gt's @replace@1130. + * __@search@1133: + * type: object + * description: The $gt's @search@1133. + * __@split@1135: + * type: object + * description: The $gt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gt's @matchall@1137. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The collection id's $gte. + * - type: object + * description: The collection id's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1128: + * type: object + * description: The $gte's @match@1128. + * __@replace@1130: + * type: object + * description: The $gte's @replace@1130. + * __@search@1133: + * type: object + * description: The $gte's @search@1133. + * __@split@1135: + * type: object + * description: The $gte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gte's @matchall@1137. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The collection id's $lt. + * - type: object + * description: The collection id's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1128: + * type: object + * description: The $lt's @match@1128. + * __@replace@1130: + * type: object + * description: The $lt's @replace@1130. + * __@search@1133: + * type: object + * description: The $lt's @search@1133. + * __@split@1135: + * type: object + * description: The $lt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lt's @matchall@1137. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The collection id's $lte. + * - type: object + * description: The collection id's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1128: + * type: object + * description: The $lte's @match@1128. + * __@replace@1130: + * type: object + * description: The $lte's @replace@1130. + * __@search@1133: + * type: object + * description: The $lte's @search@1133. + * __@split@1135: + * type: object + * description: The $lte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lte's @matchall@1137. + * $like: + * type: string + * title: $like + * description: The collection id's $like. + * $re: + * type: string + * title: $re + * description: The collection id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The collection id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The collection id's $fulltext. + * $overlap: + * type: array + * description: The collection id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The collection id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The collection id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The collection id's $exists. + * - name: created_at + * in: query + * description: The product's created at. + * required: false + * schema: + * type: object + * description: The product's created at. + * properties: + * $and: + * type: array + * description: The created at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * $or: + * type: array + * description: The created at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1128: + * type: object + * description: The $ne's @match@1128. + * __@replace@1130: + * type: object + * description: The $ne's @replace@1130. + * __@search@1133: + * type: object + * description: The $ne's @search@1133. + * __@split@1135: + * type: object + * description: The $ne's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $ne's @matchall@1137. + * $in: + * type: array + * description: The created at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1128: + * type: object + * description: The $in's @match@1128. + * __@replace@1130: + * type: object + * description: The $in's @replace@1130. + * __@search@1133: + * type: object + * description: The $in's @search@1133. + * __@split@1135: + * type: object + * description: The $in's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $in's @matchall@1137. + * $nin: + * type: array + * description: The created at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1128: + * type: object + * description: The $nin's @match@1128. + * __@replace@1130: + * type: object + * description: The $nin's @replace@1130. + * __@search@1133: + * type: object + * description: The $nin's @search@1133. + * __@split@1135: + * type: object + * description: The $nin's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $nin's @matchall@1137. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * - type: object + * description: The created at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1128: + * type: object + * description: The $gt's @match@1128. + * __@replace@1130: + * type: object + * description: The $gt's @replace@1130. + * __@search@1133: + * type: object + * description: The $gt's @search@1133. + * __@split@1135: + * type: object + * description: The $gt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gt's @matchall@1137. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1128: + * type: object + * description: The $gte's @match@1128. + * __@replace@1130: + * type: object + * description: The $gte's @replace@1130. + * __@search@1133: + * type: object + * description: The $gte's @search@1133. + * __@split@1135: + * type: object + * description: The $gte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gte's @matchall@1137. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1128: + * type: object + * description: The $lt's @match@1128. + * __@replace@1130: + * type: object + * description: The $lt's @replace@1130. + * __@search@1133: + * type: object + * description: The $lt's @search@1133. + * __@split@1135: + * type: object + * description: The $lt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lt's @matchall@1137. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1128: + * type: object + * description: The $lte's @match@1128. + * __@replace@1130: + * type: object + * description: The $lte's @replace@1130. + * __@search@1133: + * type: object + * description: The $lte's @search@1133. + * __@split@1135: + * type: object + * description: The $lte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lte's @matchall@1137. + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * - name: updated_at + * in: query + * description: The product's updated at. + * required: false + * schema: + * type: object + * description: The product's updated at. + * properties: + * $and: + * type: array + * description: The updated at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * $or: + * type: array + * description: The updated at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1128: + * type: object + * description: The $ne's @match@1128. + * __@replace@1130: + * type: object + * description: The $ne's @replace@1130. + * __@search@1133: + * type: object + * description: The $ne's @search@1133. + * __@split@1135: + * type: object + * description: The $ne's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $ne's @matchall@1137. + * $in: + * type: array + * description: The updated at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1128: + * type: object + * description: The $in's @match@1128. + * __@replace@1130: + * type: object + * description: The $in's @replace@1130. + * __@search@1133: + * type: object + * description: The $in's @search@1133. + * __@split@1135: + * type: object + * description: The $in's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $in's @matchall@1137. + * $nin: + * type: array + * description: The updated at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1128: + * type: object + * description: The $nin's @match@1128. + * __@replace@1130: + * type: object + * description: The $nin's @replace@1130. + * __@search@1133: + * type: object + * description: The $nin's @search@1133. + * __@split@1135: + * type: object + * description: The $nin's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $nin's @matchall@1137. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * - type: object + * description: The updated at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1128: + * type: object + * description: The $gt's @match@1128. + * __@replace@1130: + * type: object + * description: The $gt's @replace@1130. + * __@search@1133: + * type: object + * description: The $gt's @search@1133. + * __@split@1135: + * type: object + * description: The $gt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gt's @matchall@1137. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1128: + * type: object + * description: The $gte's @match@1128. + * __@replace@1130: + * type: object + * description: The $gte's @replace@1130. + * __@search@1133: + * type: object + * description: The $gte's @search@1133. + * __@split@1135: + * type: object + * description: The $gte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gte's @matchall@1137. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1128: + * type: object + * description: The $lt's @match@1128. + * __@replace@1130: + * type: object + * description: The $lt's @replace@1130. + * __@search@1133: + * type: object + * description: The $lt's @search@1133. + * __@split@1135: + * type: object + * description: The $lt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lt's @matchall@1137. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1128: + * type: object + * description: The $lte's @match@1128. + * __@replace@1130: + * type: object + * description: The $lte's @replace@1130. + * __@search@1133: + * type: object + * description: The $lte's @search@1133. + * __@split@1135: + * type: object + * description: The $lte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lte's @matchall@1137. + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * - name: deleted_at + * in: query + * description: The product's deleted at. + * required: false + * schema: + * type: object + * description: The product's deleted at. + * properties: + * $and: + * type: array + * description: The deleted at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $and's $eq. + * - type: object + * description: The $and's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $and's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $and's $ne. + * - type: object + * description: The $and's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $and's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $and's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $and's $not. + * - type: object + * description: The $and's $not. + * x-schemaName: RegExp + * - type: object + * description: The $and's $not. + * - type: array + * description: The $and's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $and's $gt. + * - type: object + * description: The $and's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $and's $gte. + * - type: object + * description: The $and's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $and's $lt. + * - type: object + * description: The $and's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $and's $lte. + * - type: object + * description: The $and's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $and's $like. + * $re: + * type: string + * title: $re + * description: The $and's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $and's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $and's $fulltext. + * $overlap: + * type: array + * description: The $and's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $and's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $and's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $and's $exists. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $and's exec. + * test: + * type: object + * description: The $and's test. + * source: + * type: string + * title: source + * description: The $and's source. + * global: + * type: boolean + * title: global + * description: The $and's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $and's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $and's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $and's lastindex. + * compile: + * type: object + * description: The $and's compile. + * flags: + * type: string + * title: flags + * description: The $and's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $and's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $and's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $and's dotall. + * __@match@1128: + * type: object + * description: The $and's @match@1128. + * __@replace@1130: + * type: object + * description: The $and's @replace@1130. + * __@search@1133: + * type: object + * description: The $and's @search@1133. + * __@split@1135: + * type: object + * description: The $and's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $and's @matchall@1137. + * $or: + * type: array + * description: The deleted at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $or's $eq. + * - type: object + * description: The $or's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $or's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $or's $ne. + * - type: object + * description: The $or's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $or's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $or's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $or's $not. + * - type: object + * description: The $or's $not. + * x-schemaName: RegExp + * - type: object + * description: The $or's $not. + * - type: array + * description: The $or's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $or's $gt. + * - type: object + * description: The $or's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $or's $gte. + * - type: object + * description: The $or's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $or's $lt. + * - type: object + * description: The $or's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $or's $lte. + * - type: object + * description: The $or's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $or's $like. + * $re: + * type: string + * title: $re + * description: The $or's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $or's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $or's $fulltext. + * $overlap: + * type: array + * description: The $or's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $or's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $or's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $or's $exists. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $or's exec. + * test: + * type: object + * description: The $or's test. + * source: + * type: string + * title: source + * description: The $or's source. + * global: + * type: boolean + * title: global + * description: The $or's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $or's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $or's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $or's lastindex. + * compile: + * type: object + * description: The $or's compile. + * flags: + * type: string + * title: flags + * description: The $or's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $or's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $or's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $or's dotall. + * __@match@1128: + * type: object + * description: The $or's @match@1128. + * __@replace@1130: + * type: object + * description: The $or's @replace@1130. + * __@search@1133: + * type: object + * description: The $or's @search@1133. + * __@split@1135: + * type: object + * description: The $or's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $or's @matchall@1137. + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $eq's exec. + * test: + * type: object + * description: The $eq's test. + * source: + * type: string + * title: source + * description: The $eq's source. + * global: + * type: boolean + * title: global + * description: The $eq's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $eq's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $eq's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $eq's lastindex. + * compile: + * type: object + * description: The $eq's compile. + * flags: + * type: string + * title: flags + * description: The $eq's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $eq's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $eq's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $eq's dotall. + * __@match@1128: + * type: object + * description: The $eq's @match@1128. + * __@replace@1130: + * type: object + * description: The $eq's @replace@1130. + * __@search@1133: + * type: object + * description: The $eq's @search@1133. + * __@split@1135: + * type: object + * description: The $eq's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $eq's @matchall@1137. + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $ne's exec. + * test: + * type: object + * description: The $ne's test. + * source: + * type: string + * title: source + * description: The $ne's source. + * global: + * type: boolean + * title: global + * description: The $ne's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $ne's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $ne's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $ne's lastindex. + * compile: + * type: object + * description: The $ne's compile. + * flags: + * type: string + * title: flags + * description: The $ne's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $ne's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $ne's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $ne's dotall. + * __@match@1128: + * type: object + * description: The $ne's @match@1128. + * __@replace@1130: + * type: object + * description: The $ne's @replace@1130. + * __@search@1133: + * type: object + * description: The $ne's @search@1133. + * __@split@1135: + * type: object + * description: The $ne's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $ne's @matchall@1137. + * $in: + * type: array + * description: The deleted at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $in's exec. + * test: + * type: object + * description: The $in's test. + * source: + * type: string + * title: source + * description: The $in's source. + * global: + * type: boolean + * title: global + * description: The $in's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $in's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $in's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $in's lastindex. + * compile: + * type: object + * description: The $in's compile. + * flags: + * type: string + * title: flags + * description: The $in's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $in's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $in's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $in's dotall. + * __@match@1128: + * type: object + * description: The $in's @match@1128. + * __@replace@1130: + * type: object + * description: The $in's @replace@1130. + * __@search@1133: + * type: object + * description: The $in's @search@1133. + * __@split@1135: + * type: object + * description: The $in's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $in's @matchall@1137. + * $nin: + * type: array + * description: The deleted at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $nin's exec. + * test: + * type: object + * description: The $nin's test. + * source: + * type: string + * title: source + * description: The $nin's source. + * global: + * type: boolean + * title: global + * description: The $nin's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $nin's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $nin's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $nin's lastindex. + * compile: + * type: object + * description: The $nin's compile. + * flags: + * type: string + * title: flags + * description: The $nin's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $nin's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $nin's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $nin's dotall. + * __@match@1128: + * type: object + * description: The $nin's @match@1128. + * __@replace@1130: + * type: object + * description: The $nin's @replace@1130. + * __@search@1133: + * type: object + * description: The $nin's @search@1133. + * __@split@1135: + * type: object + * description: The $nin's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $nin's @matchall@1137. + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * - type: object + * description: The deleted at's $not. + * properties: + * $and: + * type: array + * description: The $not's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The $not's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The $not's $eq. + * - type: object + * description: The $not's $eq. + * x-schemaName: RegExp + * - type: array + * description: The $not's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The $not's $ne. + * - type: object + * description: The $not's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The $not's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The $not's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * - type: object + * description: The $not's details. + * - type: array + * description: The $not's details. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The $not's $gt. + * - type: object + * description: The $not's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The $not's $gte. + * - type: object + * description: The $not's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The $not's $lt. + * - type: object + * description: The $not's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The $not's $lte. + * - type: object + * description: The $not's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The $not's $like. + * $re: + * type: string + * title: $re + * description: The $not's $re. + * $ilike: + * type: string + * title: $ilike + * description: The $not's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The $not's $fulltext. + * $overlap: + * type: array + * description: The $not's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The $not's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The $not's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The $not's $exists. + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $not's exec. + * test: + * type: object + * description: The $not's test. + * source: + * type: string + * title: source + * description: The $not's source. + * global: + * type: boolean + * title: global + * description: The $not's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $not's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $not's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $not's lastindex. + * compile: + * type: object + * description: The $not's compile. + * flags: + * type: string + * title: flags + * description: The $not's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $not's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $not's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $not's dotall. + * __@match@1128: + * type: object + * description: The $not's @match@1128. + * __@replace@1130: + * type: object + * description: The $not's @replace@1130. + * __@search@1133: + * type: object + * description: The $not's @search@1133. + * __@split@1135: + * type: object + * description: The $not's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $not's @matchall@1137. + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gt's exec. + * test: + * type: object + * description: The $gt's test. + * source: + * type: string + * title: source + * description: The $gt's source. + * global: + * type: boolean + * title: global + * description: The $gt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gt's lastindex. + * compile: + * type: object + * description: The $gt's compile. + * flags: + * type: string + * title: flags + * description: The $gt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gt's dotall. + * __@match@1128: + * type: object + * description: The $gt's @match@1128. + * __@replace@1130: + * type: object + * description: The $gt's @replace@1130. + * __@search@1133: + * type: object + * description: The $gt's @search@1133. + * __@split@1135: + * type: object + * description: The $gt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gt's @matchall@1137. + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $gte's exec. + * test: + * type: object + * description: The $gte's test. + * source: + * type: string + * title: source + * description: The $gte's source. + * global: + * type: boolean + * title: global + * description: The $gte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $gte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $gte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $gte's lastindex. + * compile: + * type: object + * description: The $gte's compile. + * flags: + * type: string + * title: flags + * description: The $gte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $gte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $gte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $gte's dotall. + * __@match@1128: + * type: object + * description: The $gte's @match@1128. + * __@replace@1130: + * type: object + * description: The $gte's @replace@1130. + * __@search@1133: + * type: object + * description: The $gte's @search@1133. + * __@split@1135: + * type: object + * description: The $gte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $gte's @matchall@1137. + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lt's exec. + * test: + * type: object + * description: The $lt's test. + * source: + * type: string + * title: source + * description: The $lt's source. + * global: + * type: boolean + * title: global + * description: The $lt's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lt's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lt's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lt's lastindex. + * compile: + * type: object + * description: The $lt's compile. + * flags: + * type: string + * title: flags + * description: The $lt's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lt's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lt's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lt's dotall. + * __@match@1128: + * type: object + * description: The $lt's @match@1128. + * __@replace@1130: + * type: object + * description: The $lt's @replace@1130. + * __@search@1133: + * type: object + * description: The $lt's @search@1133. + * __@split@1135: + * type: object + * description: The $lt's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lt's @matchall@1137. + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * required: + * - exec + * - test + * - source + * - global + * - ignoreCase + * - multiline + * - lastIndex + * - flags + * - sticky + * - unicode + * - dotAll + * - __@match@1128 + * - __@replace@1130 + * - __@search@1133 + * - __@matchAll@1137 + * properties: + * exec: + * type: object + * description: The $lte's exec. + * test: + * type: object + * description: The $lte's test. + * source: + * type: string + * title: source + * description: The $lte's source. + * global: + * type: boolean + * title: global + * description: The $lte's global. + * ignoreCase: + * type: boolean + * title: ignoreCase + * description: The $lte's ignorecase. + * multiline: + * type: boolean + * title: multiline + * description: The $lte's multiline. + * lastIndex: + * type: number + * title: lastIndex + * description: The $lte's lastindex. + * compile: + * type: object + * description: The $lte's compile. + * flags: + * type: string + * title: flags + * description: The $lte's flags. + * sticky: + * type: boolean + * title: sticky + * description: The $lte's sticky. + * unicode: + * type: boolean + * title: unicode + * description: The $lte's unicode. + * dotAll: + * type: boolean + * title: dotAll + * description: The $lte's dotall. + * __@match@1128: + * type: object + * description: The $lte's @match@1128. + * __@replace@1130: + * type: object + * description: The $lte's @replace@1130. + * __@search@1133: + * type: object + * description: The $lte's @search@1133. + * __@split@1135: + * type: object + * description: The $lte's @split@1135. + * __@matchAll@1137: + * type: object + * description: The $lte's @matchall@1137. + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * - name: $and + * in: query + * description: The product's $and. + * required: false + * schema: + * type: array + * description: The product's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $and's sales channel id. + * - type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $and's handle. + * - type: array + * description: The $and's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * tags: + * type: object + * description: The $and's tags. + * properties: + * value: + * type: array + * description: The tag's value. + * items: + * type: string + * title: value + * description: The value's details. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $and's type id. + * - type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $and's category id. + * - type: array + * description: The $and's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $and's category id. + * properties: + * $and: + * type: array + * description: The category id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The category id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The category id's $eq. + * - type: object + * description: The category id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The category id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The category id's $ne. + * - type: object + * description: The category id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The category id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The category id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The category id's $not. + * - type: object + * description: The category id's $not. + * x-schemaName: RegExp + * - type: object + * description: The category id's $not. + * - type: array + * description: The category id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The category id's $gt. + * - type: object + * description: The category id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The category id's $gte. + * - type: object + * description: The category id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The category id's $lt. + * - type: object + * description: The category id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The category id's $lte. + * - type: object + * description: The category id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The category id's $like. + * $re: + * type: string + * title: $re + * description: The category id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The category id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The category id's $fulltext. + * $overlap: + * type: array + * description: The category id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The category id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The category id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The category id's $exists. + * categories: + * oneOf: + * - type: object + * description: The $and's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * - type: object + * description: The $and's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $and's collection id. + * - type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $and's collection id. + * properties: + * $and: + * type: array + * description: The collection id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The collection id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The collection id's $eq. + * - type: object + * description: The collection id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The collection id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The collection id's $ne. + * - type: object + * description: The collection id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The collection id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The collection id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The collection id's $not. + * - type: object + * description: The collection id's $not. + * x-schemaName: RegExp + * - type: object + * description: The collection id's $not. + * - type: array + * description: The collection id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The collection id's $gt. + * - type: object + * description: The collection id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The collection id's $gte. + * - type: object + * description: The collection id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The collection id's $lt. + * - type: object + * description: The collection id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The collection id's $lte. + * - type: object + * description: The collection id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The collection id's $like. + * $re: + * type: string + * title: $re + * description: The collection id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The collection id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The collection id's $fulltext. + * $overlap: + * type: array + * description: The collection id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The collection id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The collection id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The collection id's $exists. + * created_at: + * type: object + * description: The $and's created at. + * properties: + * $and: + * type: array + * description: The created at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The created at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The created at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The created at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * - type: object + * description: The created at's $not. + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * updated_at: + * type: object + * description: The $and's updated at. + * properties: + * $and: + * type: array + * description: The updated at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The updated at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The updated at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The updated at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * - type: object + * description: The updated at's $not. + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * deleted_at: + * type: object + * description: The $and's deleted at. + * properties: + * $and: + * type: array + * description: The deleted at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The deleted at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The deleted at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The deleted at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * - type: object + * description: The deleted at's $not. + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $and's sales channel id. + * - type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $and's handle. + * - type: array + * description: The $and's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * tags: + * type: object + * description: The $and's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $and's type id. + * - type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $and's category id. + * - type: array + * description: The $and's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $and's category id. + * categories: + * oneOf: + * - type: object + * description: The $and's categories. + * - type: object + * description: The $and's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $and's collection id. + * - type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $and's collection id. + * created_at: + * type: object + * description: The $and's created at. + * updated_at: + * type: object + * description: The $and's updated at. + * deleted_at: + * type: object + * description: The $and's deleted at. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $or's sales channel id. + * - type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $or's handle. + * - type: array + * description: The $or's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * tags: + * type: object + * description: The $or's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $or's type id. + * - type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $or's category id. + * - type: array + * description: The $or's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $or's category id. + * categories: + * oneOf: + * - type: object + * description: The $or's categories. + * - type: object + * description: The $or's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $or's collection id. + * - type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $or's collection id. + * created_at: + * type: object + * description: The $or's created at. + * updated_at: + * type: object + * description: The $or's updated at. + * deleted_at: + * type: object + * description: The $or's deleted at. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $and's sales channel id. + * - type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $and's handle. + * - type: array + * description: The $and's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * tags: + * type: object + * description: The $and's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $and's type id. + * - type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $and's category id. + * - type: array + * description: The $and's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $and's category id. + * categories: + * oneOf: + * - type: object + * description: The $and's categories. + * - type: object + * description: The $and's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $and's collection id. + * - type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $and's collection id. + * created_at: + * type: object + * description: The $and's created at. + * updated_at: + * type: object + * description: The $and's updated at. + * deleted_at: + * type: object + * description: The $and's deleted at. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $or's sales channel id. + * - type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $or's handle. + * - type: array + * description: The $or's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * tags: + * type: object + * description: The $or's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $or's type id. + * - type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $or's category id. + * - type: array + * description: The $or's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $or's category id. + * categories: + * oneOf: + * - type: object + * description: The $or's categories. + * - type: object + * description: The $or's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $or's collection id. + * - type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $or's collection id. + * created_at: + * type: object + * description: The $or's created at. + * updated_at: + * type: object + * description: The $or's updated at. + * deleted_at: + * type: object + * description: The $or's deleted at. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - name: $or + * in: query + * description: The product's $or. + * required: false + * schema: + * type: array + * description: The product's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $or's sales channel id. + * - type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $or's handle. + * - type: array + * description: The $or's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * tags: + * type: object + * description: The $or's tags. + * properties: + * value: + * type: array + * description: The tag's value. + * items: + * type: string + * title: value + * description: The value's details. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $or's type id. + * - type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $or's category id. + * - type: array + * description: The $or's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $or's category id. + * properties: + * $and: + * type: array + * description: The category id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The category id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The category id's $eq. + * - type: object + * description: The category id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The category id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The category id's $ne. + * - type: object + * description: The category id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The category id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The category id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The category id's $not. + * - type: object + * description: The category id's $not. + * x-schemaName: RegExp + * - type: object + * description: The category id's $not. + * - type: array + * description: The category id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The category id's $gt. + * - type: object + * description: The category id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The category id's $gte. + * - type: object + * description: The category id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The category id's $lt. + * - type: object + * description: The category id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The category id's $lte. + * - type: object + * description: The category id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The category id's $like. + * $re: + * type: string + * title: $re + * description: The category id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The category id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The category id's $fulltext. + * $overlap: + * type: array + * description: The category id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The category id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The category id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The category id's $exists. + * categories: + * oneOf: + * - type: object + * description: The $or's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * - type: object + * description: The $or's categories. + * required: + * - id + * properties: + * id: + * type: object + * description: The category's ID. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $or's collection id. + * - type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $or's collection id. + * properties: + * $and: + * type: array + * description: The collection id's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The collection id's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The collection id's $eq. + * - type: object + * description: The collection id's $eq. + * x-schemaName: RegExp + * - type: array + * description: The collection id's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The collection id's $ne. + * - type: object + * description: The collection id's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The collection id's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The collection id's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The collection id's $not. + * - type: object + * description: The collection id's $not. + * x-schemaName: RegExp + * - type: object + * description: The collection id's $not. + * - type: array + * description: The collection id's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The collection id's $gt. + * - type: object + * description: The collection id's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The collection id's $gte. + * - type: object + * description: The collection id's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The collection id's $lt. + * - type: object + * description: The collection id's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The collection id's $lte. + * - type: object + * description: The collection id's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The collection id's $like. + * $re: + * type: string + * title: $re + * description: The collection id's $re. + * $ilike: + * type: string + * title: $ilike + * description: The collection id's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The collection id's $fulltext. + * $overlap: + * type: array + * description: The collection id's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The collection id's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The collection id's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The collection id's $exists. + * created_at: + * type: object + * description: The $or's created at. + * properties: + * $and: + * type: array + * description: The created at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The created at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The created at's $eq. + * - type: object + * description: The created at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The created at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The created at's $ne. + * - type: object + * description: The created at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The created at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The created at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The created at's $not. + * - type: object + * description: The created at's $not. + * x-schemaName: RegExp + * - type: object + * description: The created at's $not. + * - type: array + * description: The created at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The created at's $gt. + * - type: object + * description: The created at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The created at's $gte. + * - type: object + * description: The created at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The created at's $lt. + * - type: object + * description: The created at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The created at's $lte. + * - type: object + * description: The created at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The created at's $like. + * $re: + * type: string + * title: $re + * description: The created at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The created at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The created at's $fulltext. + * $overlap: + * type: array + * description: The created at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The created at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The created at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The created at's $exists. + * updated_at: + * type: object + * description: The $or's updated at. + * properties: + * $and: + * type: array + * description: The updated at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The updated at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The updated at's $eq. + * - type: object + * description: The updated at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The updated at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The updated at's $ne. + * - type: object + * description: The updated at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The updated at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The updated at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The updated at's $not. + * - type: object + * description: The updated at's $not. + * x-schemaName: RegExp + * - type: object + * description: The updated at's $not. + * - type: array + * description: The updated at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The updated at's $gt. + * - type: object + * description: The updated at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The updated at's $gte. + * - type: object + * description: The updated at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The updated at's $lt. + * - type: object + * description: The updated at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The updated at's $lte. + * - type: object + * description: The updated at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The updated at's $like. + * $re: + * type: string + * title: $re + * description: The updated at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The updated at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The updated at's $fulltext. + * $overlap: + * type: array + * description: The updated at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The updated at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The updated at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The updated at's $exists. + * deleted_at: + * type: object + * description: The $or's deleted at. + * properties: + * $and: + * type: array + * description: The deleted at's $and. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * - type: object + * description: The $and's details. + * - type: array + * description: The $and's details. + * items: + * oneOf: + * - type: string + * title: $and + * description: The $and's details. + * - type: object + * description: The $and's details. + * x-schemaName: RegExp + * $or: + * type: array + * description: The deleted at's $or. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * - type: object + * description: The $or's details. + * - type: array + * description: The $or's details. + * items: + * oneOf: + * - type: string + * title: $or + * description: The $or's details. + * - type: object + * description: The $or's details. + * x-schemaName: RegExp + * $eq: + * oneOf: + * - type: string + * title: $eq + * description: The deleted at's $eq. + * - type: object + * description: The deleted at's $eq. + * x-schemaName: RegExp + * - type: array + * description: The deleted at's $eq. + * items: + * oneOf: + * - type: string + * title: $eq + * description: The $eq's details. + * - type: object + * description: The $eq's details. + * x-schemaName: RegExp + * $ne: + * oneOf: + * - type: string + * title: $ne + * description: The deleted at's $ne. + * - type: object + * description: The deleted at's $ne. + * x-schemaName: RegExp + * $in: + * type: array + * description: The deleted at's $in. + * items: + * oneOf: + * - type: string + * title: $in + * description: The $in's details. + * - type: object + * description: The $in's details. + * x-schemaName: RegExp + * $nin: + * type: array + * description: The deleted at's $nin. + * items: + * oneOf: + * - type: string + * title: $nin + * description: The $nin's details. + * - type: object + * description: The $nin's details. + * x-schemaName: RegExp + * $not: + * oneOf: + * - type: string + * title: $not + * description: The deleted at's $not. + * - type: object + * description: The deleted at's $not. + * x-schemaName: RegExp + * - type: object + * description: The deleted at's $not. + * - type: array + * description: The deleted at's $not. + * items: + * oneOf: + * - type: string + * title: $not + * description: The $not's details. + * - type: object + * description: The $not's details. + * x-schemaName: RegExp + * $gt: + * oneOf: + * - type: string + * title: $gt + * description: The deleted at's $gt. + * - type: object + * description: The deleted at's $gt. + * x-schemaName: RegExp + * $gte: + * oneOf: + * - type: string + * title: $gte + * description: The deleted at's $gte. + * - type: object + * description: The deleted at's $gte. + * x-schemaName: RegExp + * $lt: + * oneOf: + * - type: string + * title: $lt + * description: The deleted at's $lt. + * - type: object + * description: The deleted at's $lt. + * x-schemaName: RegExp + * $lte: + * oneOf: + * - type: string + * title: $lte + * description: The deleted at's $lte. + * - type: object + * description: The deleted at's $lte. + * x-schemaName: RegExp + * $like: + * type: string + * title: $like + * description: The deleted at's $like. + * $re: + * type: string + * title: $re + * description: The deleted at's $re. + * $ilike: + * type: string + * title: $ilike + * description: The deleted at's $ilike. + * $fulltext: + * type: string + * title: $fulltext + * description: The deleted at's $fulltext. + * $overlap: + * type: array + * description: The deleted at's $overlap. + * items: + * type: string + * title: $overlap + * description: The $overlap's details. + * $contains: + * type: array + * description: The deleted at's $contains. + * items: + * type: string + * title: $contains + * description: The $contain's $contains. + * $contained: + * type: array + * description: The deleted at's $contained. + * items: + * type: string + * title: $contained + * description: The $contained's details. + * $exists: + * type: boolean + * title: $exists + * description: The deleted at's $exists. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $and's sales channel id. + * - type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $and's handle. + * - type: array + * description: The $and's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * tags: + * type: object + * description: The $and's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $and's type id. + * - type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $and's category id. + * - type: array + * description: The $and's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $and's category id. + * categories: + * oneOf: + * - type: object + * description: The $and's categories. + * - type: object + * description: The $and's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $and's collection id. + * - type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $and's collection id. + * created_at: + * type: object + * description: The $and's created at. + * updated_at: + * type: object + * description: The $and's updated at. + * deleted_at: + * type: object + * description: The $and's deleted at. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $or's sales channel id. + * - type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $or's handle. + * - type: array + * description: The $or's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * tags: + * type: object + * description: The $or's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $or's type id. + * - type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $or's category id. + * - type: array + * description: The $or's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $or's category id. + * categories: + * oneOf: + * - type: object + * description: The $or's categories. + * - type: object + * description: The $or's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $or's collection id. + * - type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $or's collection id. + * created_at: + * type: object + * description: The $or's created at. + * updated_at: + * type: object + * description: The $or's updated at. + * deleted_at: + * type: object + * description: The $or's deleted at. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: string + * title: status + * description: The $and's status. + * - type: array + * description: The $and's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $and's sales channel id. + * - type: array + * description: The $and's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $and's handle. + * - type: array + * description: The $and's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $and's is giftcard. + * tags: + * type: object + * description: The $and's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $and's type id. + * - type: array + * description: The $and's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $and's category id. + * - type: array + * description: The $and's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $and's category id. + * categories: + * oneOf: + * - type: object + * description: The $and's categories. + * - type: object + * description: The $and's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $and's collection id. + * - type: array + * description: The $and's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $and's collection id. + * created_at: + * type: object + * description: The $and's created at. + * updated_at: + * type: object + * description: The $and's updated at. + * deleted_at: + * type: object + * description: The $and's deleted at. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * status: + * oneOf: + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: string + * title: status + * description: The $or's status. + * - type: array + * description: The $or's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * sales_channel_id: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The $or's sales channel id. + * - type: array + * description: The $or's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * handle: + * oneOf: + * - type: string + * title: handle + * description: The $or's handle. + * - type: array + * description: The $or's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The $or's is giftcard. + * tags: + * type: object + * description: The $or's tags. + * type_id: + * oneOf: + * - type: string + * title: type_id + * description: The $or's type id. + * - type: array + * description: The $or's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * category_id: + * oneOf: + * - type: string + * title: category_id + * description: The $or's category id. + * - type: array + * description: The $or's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - type: object + * description: The $or's category id. + * categories: + * oneOf: + * - type: object + * description: The $or's categories. + * - type: object + * description: The $or's categories. + * collection_id: + * oneOf: + * - type: string + * title: collection_id + * description: The $or's collection id. + * - type: array + * description: The $or's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - type: object + * description: The $or's collection id. + * created_at: + * type: object + * description: The $or's created at. + * updated_at: + * type: object + * description: The $or's updated at. + * deleted_at: + * type: object + * description: The $or's deleted at. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductListParams + * - type: object + * description: The $or's details. * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +13985,41 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The product's limit. + * offset: + * type: number + * title: offset + * description: The product's offset. + * count: + * type: number + * title: count + * description: The product's count. + * - type: object + * description: SUMMARY + * required: + * - products + * properties: + * products: + * type: array + * description: The product's products. + * items: + * $ref: "#/components/schemas/AdminProduct" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +14032,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts index fa92226f64..4a95753538 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +93,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index db8b4d2235..beabcf46b1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,1044 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The product's q. + * required: false + * schema: + * type: string + * title: q + * description: The product's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: title + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: title + * description: The product's title. + * - type: array + * description: The product's title. + * items: + * type: string + * title: title + * description: The title's details. + * - name: product_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: product_id + * description: The product's product id. + * - type: array + * description: The product's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * - name: $and + * in: query + * description: The product's $and. + * required: false + * schema: + * type: array + * description: The product's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - name: $or + * in: query + * description: The product's $or. + * required: false + * schema: + * type: array + * description: The product's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $and's title. + * - type: array + * description: The $and's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * title: + * oneOf: + * - type: string + * title: title + * description: The $or's title. + * - type: array + * description: The $or's title. + * items: + * type: string + * title: title + * description: The title's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductOptionParams + * - type: object + * description: The $or's details. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +1103,41 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The product's limit. + * offset: + * type: number + * title: offset + * description: The product's offset. + * count: + * type: number + * title: count + * description: The product's count. + * - type: object + * description: SUMMARY + * required: + * - product_options + * properties: + * product_options: + * type: array + * description: The product's product options. + * items: + * $ref: "#/components/schemas/AdminProductOption" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +1150,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts index fcece8ac26..1460bd1138 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductOptionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts index 31a11f19a6..bfc7fa7a8a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,41 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The product's limit. + * offset: + * type: number + * title: offset + * description: The product's offset. + * count: + * type: number + * title: count + * description: The product's count. + * - type: object + * description: SUMMARY + * required: + * - variants + * properties: + * variants: + * type: array + * description: The product's variants. + * items: + * $ref: "#/components/schemas/AdminProductVariant" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +122,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts index 698c1e8caa..a890b9117f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductVariantResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index 93ae0864fc..4fbfb8c762 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,178 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The promotion's q. + * required: false + * schema: + * type: string + * title: q + * description: The promotion's q. + * - name: code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: code + * description: The promotion's code. + * - type: array + * description: The promotion's code. + * items: + * type: string + * title: code + * description: The code's details. + * - name: campaign_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: campaign_id + * description: The promotion's campaign id. + * - type: array + * description: The promotion's campaign id. + * items: + * type: string + * title: campaign_id + * description: The campaign id's details. + * - name: application_method + * in: query + * description: The promotion's application method. + * required: false + * schema: + * type: object + * description: The promotion's application method. + * properties: + * currency_code: + * oneOf: + * - type: string + * title: currency_code + * description: The application method's currency code. + * - type: array + * description: The application method's currency code. + * items: + * type: string + * title: currency_code + * description: The currency code's details. + * - name: created_at + * in: query + * description: The promotion's created at. + * required: false + * schema: + * type: object + * description: The promotion's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The promotion's updated at. + * required: false + * schema: + * type: object + * description: The promotion's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The promotion's deleted at. + * required: false + * schema: + * type: object + * description: The promotion's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +231,8 @@ * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +245,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts index 1547a30063..73635415db 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,42 +52,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The promotion's fields. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/promotions/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts index 448d2f623a..dadfab401f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,6 +81,8 @@ * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -83,10 +95,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts index c30470f1ad..657dfa82b9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts @@ -23,12 +23,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,12 +53,32 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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's promotion type. + * required: false + * schema: + * type: string + * title: promotion_type + * description: The promotion's promotion type. + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * title: application_method_type + * description: The promotion's application method type. * security: * - api_token: [] * - cookie_auth: [] @@ -66,6 +92,8 @@ * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -78,10 +106,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index f06c300b94..4039ccad4e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,32 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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's promotion type. + * required: false + * schema: + * type: string + * title: promotion_type + * description: The promotion's promotion type. + * - name: application_method_type + * in: query + * description: The promotion's application method type. + * required: false + * schema: + * type: string + * title: application_method_type + * description: The promotion's application method type. * security: * - api_token: [] * - cookie_auth: [] @@ -74,6 +100,8 @@ * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -86,10 +114,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index a9c4b9a52f..d371aa29d0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,173 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The region's q. + * required: false + * schema: + * type: string + * title: q + * description: The region's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The region's ID. + * - type: array + * description: The region's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: code + * description: The region's code. + * - type: array + * description: The region's code. + * items: + * type: string + * title: code + * description: The code's details. + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The region's name. + * - type: array + * description: The region's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: created_at + * in: query + * description: The region's created at. + * required: false + * schema: + * type: object + * description: The region's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The region's updated at. + * required: false + * schema: + * type: object + * description: The region's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The region's deleted at. + * required: false + * schema: + * type: object + * description: The region's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +226,8 @@ * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +240,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts index e9162bfbf4..94de7e7250 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The region's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index fc3d9df2f8..5107455c42 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,266 +46,255 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: location_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: location_id + * description: The reservation's location id. + * - type: array + * description: The reservation's location id. + * items: + * type: string + * title: location_id + * description: The location id's details. + * - name: inventory_item_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: inventory_item_id + * description: The reservation's inventory item id. + * - type: array + * description: The reservation's inventory item id. + * items: + * type: string + * title: inventory_item_id + * description: The inventory item id's details. + * - name: line_item_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: line_item_id + * description: The reservation's line item id. + * - type: array + * description: The reservation's line item id. + * items: + * type: string + * title: line_item_id + * description: The line item id's details. + * - name: created_by + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: created_by + * description: The reservation's created by. + * - type: array + * description: The reservation's created by. + * items: + * type: string + * title: created_by + * description: The created by's details. + * - name: description + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: description + * description: The reservation's description. + * - type: object + * description: The reservation's description. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: quantity + * in: query + * description: The reservation's quantity. + * required: false + * schema: + * type: object + * description: The reservation's quantity. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: created_at + * in: query + * description: The reservation's created at. + * required: false + * schema: + * type: object + * description: The reservation's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The reservation's updated at. + * required: false + * schema: + * type: object + * description: The reservation's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The reservation's deleted at. + * required: false + * schema: + * type: object + * description: The reservation's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - limit - * - fields - * - order - * - offset - * - location_id - * - inventory_item_id - * - line_item_id - * - created_by - * - description - * - quantity - * - created_at - * - updated_at - * - deleted_at - * properties: - * limit: - * type: number - * title: limit - * description: The reservation's limit. - * fields: - * type: string - * title: fields - * description: The reservation's fields. - * order: - * type: string - * title: order - * description: The reservation's order. - * offset: - * type: number - * title: offset - * description: The reservation's offset. - * location_id: - * oneOf: - * - type: string - * title: location_id - * description: The reservation's location id. - * - type: array - * description: The reservation's location id. - * items: - * type: string - * title: location_id - * description: The location id's details. - * inventory_item_id: - * oneOf: - * - type: string - * title: inventory_item_id - * description: The reservation's inventory item id. - * - type: array - * description: The reservation's inventory item id. - * items: - * type: string - * title: inventory_item_id - * description: The inventory item id's details. - * line_item_id: - * oneOf: - * - type: string - * title: line_item_id - * description: The reservation's line item id. - * - type: array - * description: The reservation's line item id. - * items: - * type: string - * title: line_item_id - * description: The line item id's details. - * created_by: - * oneOf: - * - type: string - * title: created_by - * description: The reservation's created by. - * - type: array - * description: The reservation's created by. - * items: - * type: string - * title: created_by - * description: The created by's details. - * description: - * oneOf: - * - type: string - * title: description - * description: The reservation's description. - * - type: object - * description: The reservation's description. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * quantity: - * type: object - * description: The reservation's quantity. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * created_at: - * type: object - * description: The reservation's created at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * updated_at: - * type: object - * description: The reservation's updated at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} - * deleted_at: - * type: object - * description: The reservation's deleted at. - * required: - * - $eq - * - $ne - * - $in - * - $nin - * - $like - * - $ilike - * - $re - * - $contains - * - $gt - * - $gte - * - $lt - * - $lte - * properties: - * $eq: {} - * $ne: {} - * $in: {} - * $nin: {} - * $like: {} - * $ilike: {} - * $re: {} - * $contains: {} - * $gt: {} - * $gte: {} - * $lt: {} - * $lte: {} * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/reservations' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "limit": 7964169955442688, - * "fields": "{value}", - * "order": "{value}", - * "offset": 3052067430072320, - * "quantity": {}, - * "created_at": {}, - * "updated_at": {}, - * "deleted_at": {} - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Reservations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts index 676d960b0f..fb8187c655 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,42 +52,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The reservation's fields. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/reservations/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Reservations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts new file mode 100644 index 0000000000..b185550e80 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts @@ -0,0 +1,89 @@ +/** + * @oas [get] /admin/return-reasons + * operationId: GetReturnReasons + * summary: List Return Reasons + * description: Retrieve a list of return reasons. The return reasons can be + * filtered by fields such as `id`. The return reasons can also be sorted or + * paginated. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/return-reasons' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Return Reasons + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts new file mode 100644 index 0000000000..27a8a715a2 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts @@ -0,0 +1,94 @@ +/** + * @oas [get] /admin/return-reasons/{id} + * operationId: GetReturnReasonsId + * summary: Get a Return Reason + * description: Retrieve a return reason by its ID. You can expand the return + * reason's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/return-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Return Reasons + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts similarity index 57% rename from www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts rename to www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index d6b6b52136..023798f99c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -1,9 +1,9 @@ /** - * @oas [get] /admin/promotions/rule-operator-options - * operationId: GetPromotionsRuleOperatorOptions - * summary: List Promotions - * description: Retrieve a list of promotions. The promotions can be filtered by - * fields such as `id`. The promotions can also be sorted or paginated. + * @oas [get] /admin/returns + * operationId: GetReturns + * summary: List Returns + * description: Retrieve a list of returns. The returns can be filtered by fields + * such as `id`. The returns can also be sorted or paginated. * x-authenticated: true * parameters: * - name: expand @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -54,11 +64,13 @@ * - lang: Shell * label: cURL * source: |- - * curl '{backend_url}/admin/promotions/rule-operator-options' \ + * curl '{backend_url}/admin/returns' \ * -H 'x-medusa-access-token: {api_token}' * tags: - * - Promotions + * - Returns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts new file mode 100644 index 0000000000..28b8744d34 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts @@ -0,0 +1,94 @@ +/** + * @oas [get] /admin/returns/{id} + * operationId: GetReturnsId + * summary: Get a Return + * description: Retrieve a return by its ID. You can expand the return's relations + * or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/returns/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index 50afe5dcf9..6dc41c0e77 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,203 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The sales channel's q. + * required: false + * schema: + * type: string + * title: q + * description: The sales channel's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The sales channel's ID. + * - type: array + * description: The sales channel's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The sales channel's name. + * - type: array + * description: The sales channel's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: description + * in: query + * description: The sales channel's description. + * required: false + * schema: + * type: string + * title: description + * description: The sales channel's description. + * - name: is_disabled + * in: query + * description: The sales channel's is disabled. + * required: true + * schema: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * - name: created_at + * in: query + * description: The sales channel's created at. + * required: false + * schema: + * type: object + * description: The sales channel's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The sales channel's updated at. + * required: false + * schema: + * type: object + * description: The sales channel's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The sales channel's deleted at. + * required: false + * schema: + * type: object + * description: The sales channel's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: location_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: location_id + * description: The sales channel's location id. + * - type: array + * description: The sales channel's location id. + * items: + * type: string + * title: location_id + * description: The location id's details. + * - name: publishable_key_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: publishable_key_id + * description: The sales channel's publishable key id. + * - type: array + * description: The sales channel's publishable key id. + * items: + * type: string + * title: publishable_key_id + * description: The publishable key id's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -60,6 +257,8 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -72,10 +271,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts index 671d17d90d..50dfb004a4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The sales channel's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index e8b97a0e7e..5dcd179f6a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,57 +47,203 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The shipping option's ID. + * - type: array + * description: The shipping option's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: q + * in: query + * description: The shipping option's q. + * required: false + * schema: + * type: string + * title: q + * description: The shipping option's q. + * - name: service_zone_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: service_zone_id + * description: The shipping option's service zone id. + * - type: array + * description: The shipping option's service zone id. + * items: + * type: string + * title: service_zone_id + * description: The service zone id's details. + * - name: shipping_profile_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: shipping_profile_id + * description: The shipping option's shipping profile id. + * - type: array + * description: The shipping option's shipping profile id. + * items: + * type: string + * title: shipping_profile_id + * description: The shipping profile id's details. + * - name: provider_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: provider_id + * description: The shipping option's provider id. + * - type: array + * description: The shipping option's provider id. + * items: + * type: string + * title: provider_id + * description: The provider id's details. + * - name: shipping_option_type_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: shipping_option_type_id + * description: The shipping option's shipping option type id. + * - type: array + * description: The shipping option's shipping option type id. + * items: + * type: string + * title: shipping_option_type_id + * description: The shipping option type id's details. + * - name: created_at + * in: query + * description: The shipping option's created at. + * required: false + * schema: + * type: object + * description: The shipping option's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The shipping option's updated at. + * required: false + * schema: + * type: object + * description: The shipping option's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The shipping option's deleted at. + * required: false + * schema: + * type: object + * description: The shipping option's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * - offset - * - limit - * - order - * properties: - * fields: - * type: string - * title: fields - * description: The shipping option's fields. - * offset: - * type: number - * title: offset - * description: The shipping option's offset. - * limit: - * type: number - * title: limit - * description: The shipping option's limit. - * order: - * type: string - * title: order - * description: The shipping option's order. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/shipping-options' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}", - * "offset": 8788876090933248, - * "limit": 2996103177830400, - * "order": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Shipping Options * responses: @@ -100,7 +252,36 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminShippingOptionListResponse" + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The shipping option's limit. + * offset: + * type: number + * title: offset + * description: The shipping option's offset. + * count: + * type: number + * title: count + * description: The shipping option's count. + * - type: object + * description: SUMMARY + * required: + * - shipping_options + * properties: + * shipping_options: + * type: array + * description: The shipping option's shipping options. + * items: + * $ref: "#/components/schemas/AdminShippingOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index 3065bc7361..16430cc62d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,161 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The shipping profile's ID. + * - type: array + * description: The shipping profile's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: q + * in: query + * description: The shipping profile's q. + * required: false + * schema: + * type: string + * title: q + * description: The shipping profile's q. + * - name: type + * in: query + * description: The shipping profile's type. + * required: false + * schema: + * type: string + * title: type + * description: The shipping profile's type. + * - name: name + * in: query + * description: The shipping profile's name. + * required: false + * schema: + * type: string + * title: name + * description: The shipping profile's name. + * - name: created_at + * in: query + * description: The shipping profile's created at. + * required: false + * schema: + * type: object + * description: The shipping profile's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The shipping profile's updated at. + * required: false + * schema: + * type: object + * description: The shipping profile's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The shipping profile's deleted at. + * required: false + * schema: + * type: object + * description: The shipping profile's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -65,7 +220,36 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminShippingProfilesResponse" + * allOf: + * - type: object + * description: SUMMARY + * required: + * - limit + * - offset + * - count + * properties: + * limit: + * type: number + * title: limit + * description: The shipping profile's limit. + * offset: + * type: number + * title: offset + * description: The shipping profile's offset. + * count: + * type: number + * title: count + * description: The shipping profile's count. + * - type: object + * description: SUMMARY + * required: + * - shipping_profiles + * properties: + * shipping_profiles: + * type: array + * description: The shipping profile's shipping profiles. + * items: + * $ref: "#/components/schemas/AdminShippingProfile" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -78,10 +262,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts index a1bea13ef1..829a91a444 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,39 +52,26 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The shipping profile's fields. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl '{backend_url}/admin/shipping-profiles/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Shipping Profiles * responses: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index ed56a6ac4c..433948c55b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,187 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The stock location's q. + * required: false + * schema: + * type: string + * title: q + * description: The stock location's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The stock location's ID. + * - type: array + * description: The stock location's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The stock location's name. + * - type: array + * description: The stock location's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: address_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: address_id + * description: The stock location's address id. + * - type: array + * description: The stock location's address id. + * items: + * type: string + * title: address_id + * description: The address id's details. + * - name: sales_channel_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: sales_channel_id + * description: The stock location's sales channel id. + * - type: array + * description: The stock location's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * - name: created_at + * in: query + * description: The stock location's created at. + * required: false + * schema: + * type: object + * description: The stock location's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The stock location's updated at. + * required: false + * schema: + * type: object + * description: The stock location's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The stock location's deleted at. + * required: false + * schema: + * type: object + * description: The stock location's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -60,6 +241,8 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -72,10 +255,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts index adb3611cdb..6f41ea2c71 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,19 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The stock location's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts index 6d2def2e7f..eec4d15f78 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,60 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The store's q. + * required: false + * schema: + * type: string + * title: q + * description: The store's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The store's ID. + * - type: array + * description: The store's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The store's name. + * - type: array + * description: The store's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +113,8 @@ * tags: * - Stores * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +127,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts index aa9de9e818..e327fafff6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Stores * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The store's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index ca456fe187..85b65c7641 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,181 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The tax rate's q. + * required: false + * schema: + * type: string + * title: q + * description: The tax rate's q. + * - name: tax_region_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: tax_region_id + * description: The tax rate's tax region id. + * - type: array + * description: The tax rate's tax region id. + * items: + * type: string + * title: tax_region_id + * description: The tax region id's details. + * - type: object + * description: The tax rate's tax region id. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: is_default + * in: query + * required: false + * schema: + * type: string + * enum: + * - "true" + * - "false" + * - name: created_at + * in: query + * description: The tax rate's created at. + * required: false + * schema: + * type: object + * description: The tax rate's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The tax rate's updated at. + * required: false + * schema: + * type: object + * description: The tax rate's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The tax rate's deleted at. + * required: false + * schema: + * type: object + * description: The tax rate's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +234,8 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +248,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts index 97365a938a..3bc8088e05 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The tax rate's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index 0e46061d53..9c20fc18e9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,285 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The tax region's q. + * required: false + * schema: + * type: string + * title: q + * description: The tax region's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The tax region's ID. + * - type: array + * description: The tax region's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: country_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: country_code + * description: The tax region's country code. + * - type: array + * description: The tax region's country code. + * items: + * type: string + * title: country_code + * description: The country code's details. + * - type: object + * description: The tax region's country code. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: province_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: province_code + * description: The tax region's province code. + * - type: array + * description: The tax region's province code. + * items: + * type: string + * title: province_code + * description: The province code's details. + * - type: object + * description: The tax region's province code. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: parent_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: parent_id + * description: The tax region's parent id. + * - type: array + * description: The tax region's parent id. + * items: + * type: string + * title: parent_id + * description: The parent id's details. + * - type: object + * description: The tax region's parent id. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: created_by + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: created_by + * description: The tax region's created by. + * - type: array + * description: The tax region's created by. + * items: + * type: string + * title: created_by + * description: The created by's details. + * - name: created_at + * in: query + * description: The tax region's created at. + * required: false + * schema: + * type: object + * description: The tax region's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The tax region's updated at. + * required: false + * schema: + * type: object + * description: The tax region's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The tax region's deleted at. + * required: false + * schema: + * type: object + * description: The tax region's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] @@ -59,6 +338,8 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +352,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts index f764dac675..e0f87d040d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Tax Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts index 5cbc3bc861..a901884661 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Uploads * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index f2a05a06aa..fe20c1e22b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -4,7 +4,7 @@ * summary: List Users * description: Retrieve a list of users. The users can be filtered by fields such * as `id`. The users can also be sorted or paginated. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,25 +46,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/admin/users' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl '{backend_url}/admin/users' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +77,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts index 626c298cb0..301ac26b07 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts @@ -4,7 +4,7 @@ * summary: Get a User * description: Retrieve a user by its ID. You can expand the user's relations or * select the fields that should be returned. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,25 +52,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/admin/users/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl '{backend_url}/admin/users/{id}' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts index 6b034a9c89..5f68d8a7fe 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts @@ -4,7 +4,7 @@ * summary: List Users * description: Retrieve a list of users. The users can be filtered by fields such * as `id`. The users can also be sorted or paginated. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,25 +46,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/admin/users/me' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl '{backend_url}/admin/users/me' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +77,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts index 356625c119..312c9439a4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,44 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: transaction_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * - type: array + * description: The workflows execution's transaction id. + * items: + * type: string + * title: transaction_id + * description: The transaction id's details. + * - name: workflow_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: workflow_id + * description: The workflows execution's workflow id. + * - type: array + * description: The workflows execution's workflow id. + * items: + * type: string + * title: workflow_id + * description: The workflow id's details. * security: * - api_token: [] * - cookie_auth: [] @@ -60,6 +98,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -72,57 +112,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - limit - * - fields - * - order - * - offset - * - transaction_id - * - workflow_id - * properties: - * limit: - * type: number - * title: limit - * description: The workflows execution's limit. - * fields: - * type: string - * title: fields - * description: The workflows execution's fields. - * order: - * type: string - * title: order - * description: The workflows execution's order. - * offset: - * type: number - * title: offset - * description: The workflows execution's offset. - * transaction_id: - * oneOf: - * - type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * - type: array - * description: The workflows execution's transaction id. - * items: - * type: string - * title: transaction_id - * description: The transaction id's details. - * workflow_id: - * oneOf: - * - type: string - * title: workflow_id - * description: The workflows execution's workflow id. - * - type: array - * description: The workflows execution's workflow id. - * items: - * type: string - * title: workflow_id - * description: The workflow id's details. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts index 550f1a01ad..2f8c530add 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,6 +75,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,18 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The workflows execution's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts index ea20ae83a6..4fff721097 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -74,6 +84,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -86,18 +98,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The workflows execution's fields. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts index 76046d82a6..0c8428f4ed 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts @@ -35,12 +35,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -59,12 +65,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -81,6 +91,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -93,10 +105,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts index 4b066d045e..a1bb34bf43 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts @@ -23,12 +23,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -47,12 +53,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -66,6 +76,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -78,10 +90,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index d0c2a48570..36430ce307 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,21 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - type - * properties: - * title: - * type: string - * title: title - * description: The api key's title. - * type: - * type: string - * enum: - * - publishable - * - secret + * $ref: "#/components/schemas/AdminCreateApiKey" * x-codeSamples: * - lang: Shell * label: cURL @@ -82,6 +78,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index e21495cd83..38081c6c17 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,15 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * properties: - * title: - * type: string - * title: title - * description: The api key's title. + * $ref: "#/components/schemas/AdminUpdateApiKey" * x-codeSamples: * - lang: Shell * label: cURL @@ -81,6 +83,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index 54ddf7d00e..910ee3d4b2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +51,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminRevokeApiKey" * x-codeSamples: * - lang: Shell * label: cURL @@ -64,6 +79,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,18 +93,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - revoke_in - * properties: - * revoke_in: - * type: number - * title: revoke_in - * description: The api key's revoke in. * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index b106e67569..83166f8d3a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Api Keys * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index cad62dc980..3a40846c6e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,11 +69,8 @@ * - name * - campaign_identifier * - description - * - currency - * - budget * - starts_at * - ends_at - * - promotions * properties: * name: * type: string @@ -77,16 +84,12 @@ * type: string * title: description * description: The campaign's description. - * currency: - * type: string - * title: currency - * description: The campaign's currency. * budget: * type: object * description: The campaign's budget. * required: * - type - * - limit + * - currency_code * properties: * type: * type: string @@ -97,6 +100,10 @@ * type: number * title: limit * description: The budget's limit. + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. * starts_at: * type: string * title: starts_at @@ -128,25 +135,17 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Rafael", + * "name": "Gunner", * "campaign_identifier": "{value}", * "description": "{value}", - * "currency": "NZD", - * "budget": { - * "type": "{value}", - * "limit": 1649671080509440 - * }, - * "starts_at": "2024-12-08T08:39:28.574Z", - * "ends_at": "2024-11-29T15:05:33.749Z", - * "promotions": [ - * { - * "id": "id_HXbttvFHpooW0" - * } - * ] + * "starts_at": "2024-08-24T00:19:14.144Z", + * "ends_at": "2024-10-01T06:47:50.133Z" * }' * tags: * - Campaigns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 953a79bd53..7b30fb8d22 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,71 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: The promotion's campaign. - * required: - * - name - * - campaign_identifier - * - description - * - currency - * - budget - * - starts_at - * - ends_at - * - promotions - * properties: - * name: - * type: string - * title: name - * description: The campaign's name. - * campaign_identifier: - * type: string - * title: campaign_identifier - * description: The campaign's campaign identifier. - * description: - * type: string - * title: description - * description: The campaign's description. - * currency: - * type: string - * title: currency - * description: The campaign's currency. - * budget: - * type: object - * description: The campaign's budget. - * properties: - * type: - * enum: - * - spend - * - usage - * type: string - * limit: - * type: number - * title: limit - * description: The budget's limit. - * required: - * - type - * - limit - * starts_at: - * type: string - * title: starts_at - * description: The campaign's starts at. - * ends_at: - * type: string - * title: ends_at - * description: The campaign's ends at. - * promotions: - * type: array - * description: The campaign's promotions. - * items: - * type: object - * description: The promotion's promotions. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. + * $ref: "#/components/schemas/AdminUpdateCampaign" * x-codeSamples: * - lang: Shell * label: cURL @@ -132,11 +78,15 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Janessa" + * "description": "{value}", + * "starts_at": "2024-08-10T14:44:10.530Z", + * "ends_at": "2024-07-13T17:45:37.462Z" * }' * tags: * - Campaigns * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts new file mode 100644 index 0000000000..33430aeaec --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -0,0 +1,114 @@ +/** + * @oas [post] /admin/campaigns/{id}/promotions + * operationId: PostCampaignsIdPromotions + * summary: Add Promotions to Campaign + * description: Add a list of promotions to a campaign. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The campaign's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The campaign's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The campaign's remove. + * items: + * type: string + * title: remove + * description: The remove's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/campaigns/{id}/promotions' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Campaigns + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts index 43a03ce7cf..62f4bf4828 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,25 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - handle - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The collection's title. - * handle: - * type: string - * title: handle - * description: The collection's handle. - * metadata: - * type: object - * description: The collection's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateCollection" * x-codeSamples: * - lang: Shell * label: cURL @@ -81,12 +73,13 @@ * -H 'Content-Type: application/json' \ * --data-raw '{ * "title": "{value}", - * "handle": "{value}", * "metadata": {} * }' * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts index 7eef514f84..44bcb6ac38 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,25 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - handle - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The collection's title. - * handle: - * type: string - * title: handle - * description: The collection's handle. - * metadata: - * type: object - * description: The collection's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminUpdateCollection" * x-codeSamples: * - lang: Shell * label: cURL @@ -86,13 +78,13 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "title": "{value}", - * "handle": "{value}", * "metadata": {} * }' * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index f9838f7cfa..82d4e200d5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts index e781ab56ee..a351f798f4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,15 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * properties: - * name: - * type: string - * title: name - * description: The customer group's name. + * $ref: "#/components/schemas/AdminCreateCustomerGroup" * x-codeSamples: * - lang: Shell * label: cURL @@ -70,11 +72,14 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Garett" + * "name": "Solon", + * "metadata": {} * }' * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts index 9526126f96..6e39c6f4e1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,15 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * properties: - * name: - * type: string - * title: name - * description: The customer group's name. + * $ref: "#/components/schemas/AdminUpdateCustomerGroup" * x-codeSamples: * - lang: Shell * label: cURL @@ -76,11 +78,14 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Wilber" + * "name": "Corbin", + * "metadata": {} * }' * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index 37cfbc5376..39d63ff29e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Customer Groups * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index ed18f301c6..f35d7d8b64 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,41 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - email - * - company_name - * - first_name - * - last_name - * - phone - * - metadata - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateCustomer" * x-codeSamples: * - lang: Shell * label: cURL @@ -96,7 +72,7 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "email": "Federico_Kirlin23@yahoo.com", + * "email": "Tomas.Toy16@yahoo.com", * "company_name": "{value}", * "first_name": "{value}", * "last_name": "{value}", @@ -111,7 +87,13 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCustomerResponse" + * type: object + * description: SUMMARY + * required: + * - customer + * properties: + * customer: + * $ref: "#/components/schemas/AdminCustomer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index 48fb48bf95..b84297cb2d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,41 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - email - * - company_name - * - first_name - * - last_name - * - phone - * - metadata - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminUpdateCustomer" * x-codeSamples: * - lang: Shell * label: cURL @@ -102,7 +78,7 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "email": "Esteban24@hotmail.com", + * "email": "Daren_Rodriguez-Rutherford93@gmail.com", * "company_name": "{value}", * "first_name": "{value}", * "last_name": "{value}", @@ -117,7 +93,13 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCustomerResponse" + * type: object + * description: SUMMARY + * required: + * - customer + * properties: + * customer: + * $ref: "#/components/schemas/AdminCustomer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index 028baba16f..26c49c1296 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,80 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - address_name - * - is_default_shipping - * - is_default_billing - * - company - * - first_name - * - last_name - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - phone - * - metadata - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateCustomerAddress" * x-codeSamples: * - lang: Shell * label: cURL @@ -142,8 +79,6 @@ * -H 'Content-Type: application/json' \ * --data-raw '{ * "address_name": "{value}", - * "is_default_shipping": true, - * "is_default_billing": true, * "company": "{value}", * "first_name": "{value}", * "last_name": "{value}", @@ -159,6 +94,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index ce9268768f..f8cea024cf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,12 +57,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,80 +75,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - address_name - * - is_default_shipping - * - is_default_billing - * - company - * - first_name - * - last_name - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - phone - * - metadata - * properties: - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. - * company: - * type: string - * title: company - * description: The customer's company. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateCustomerAddress" * x-codeSamples: * - lang: Shell * label: cURL @@ -148,8 +85,6 @@ * -H 'Content-Type: application/json' \ * --data-raw '{ * "address_name": "{value}", - * "is_default_shipping": false, - * "is_default_billing": true, * "company": "{value}", * "first_name": "{value}", * "last_name": "{value}", @@ -165,6 +100,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index 51df2d0801..aaa87a80e9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -56,17 +66,11 @@ * type: object * description: SUMMARY * required: - * - status * - sales_channel_id * - email * - customer_id - * - billing_address - * - shipping_address - * - items * - region_id - * - promo_codes * - currency_code - * - no_notification_order * - shipping_methods * - metadata * properties: @@ -146,7 +150,6 @@ * metadata: * type: object * description: The billing address's metadata. - * properties: {} * shipping_address: * type: object * description: The draft order's shipping address. @@ -206,7 +209,6 @@ * metadata: * type: object * description: The shipping address's metadata. - * properties: {} * items: * type: array * description: The draft order's items. @@ -267,7 +269,6 @@ * metadata: * type: object * description: The item's metadata. - * properties: {} * region_id: * type: string * title: region_id @@ -298,7 +299,6 @@ * - order_id * - name * - option_id - * - data * - amount * properties: * shipping_method_id: @@ -320,7 +320,6 @@ * data: * type: object * description: The shipping method's data. - * properties: {} * amount: * oneOf: * - type: string @@ -346,7 +345,6 @@ * metadata: * type: object * description: The draft order's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -355,59 +353,17 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "status": false, * "sales_channel_id": "{value}", - * "email": "Trent_Reilly67@gmail.com", + * "email": "Bartholome.Goodwin90@yahoo.com", * "customer_id": "{value}", - * "billing_address": { - * "first_name": "{value}", - * "last_name": "{value}", - * "phone": "{value}", - * "company": "{value}", - * "address_1": "{value}", - * "address_2": "{value}", - * "city": "{value}", - * "country_code": "{value}", - * "province": "{value}", - * "postal_code": "{value}", - * "metadata": {} - * }, - * "shipping_address": { - * "first_name": "{value}", - * "last_name": "{value}", - * "phone": "{value}", - * "company": "{value}", - * "address_1": "{value}", - * "address_2": "{value}", - * "city": "{value}", - * "country_code": "{value}", - * "province": "{value}", - * "postal_code": "{value}", - * "metadata": {} - * }, - * "items": [ - * { - * "title": "{value}", - * "sku": "{value}", - * "barcode": "{value}", - * "variant_id": "{value}", - * "quantity": 4713312751190016, - * "metadata": {} - * } - * ], * "region_id": "{value}", - * "promo_codes": [ - * "{value}" - * ], * "currency_code": "{value}", - * "no_notification_order": false, * "shipping_methods": [ * { * "shipping_method_id": "{value}", * "order_id": "{value}", - * "name": "Golden", - * "option_id": "{value}", - * "data": {} + * "name": "Cheyanne", + * "option_id": "{value}" * } * ], * "metadata": {} @@ -415,6 +371,8 @@ * tags: * - Draft Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index 26ffbc33b7..40d1bd6114 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -63,7 +73,6 @@ * description: SUMMARY * required: * - name - * - geo_zones * properties: * name: * type: string @@ -84,7 +93,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -104,7 +112,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -129,7 +136,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -159,7 +165,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -179,7 +184,6 @@ * postal_expression: * type: object * description: The geo zone's postal expression. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -188,12 +192,13 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Milan", - * "geo_zones": [] + * "name": "Layla" * }' * tags: * - Fulfillment Sets * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 31d00104c3..7f6cc42070 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,12 +57,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -69,7 +79,6 @@ * description: SUMMARY * required: * - name - * - geo_zones * properties: * name: * type: string @@ -86,7 +95,6 @@ * - type * - metadata * - country_code - * - id * properties: * type: * type: string @@ -95,7 +103,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -111,7 +118,6 @@ * - metadata * - country_code * - province_code - * - id * properties: * type: * type: string @@ -120,7 +126,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * country_code: * type: string * title: country_code @@ -141,7 +146,6 @@ * - city * - country_code * - province_code - * - id * properties: * type: * type: string @@ -150,7 +154,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * city: * type: string * title: city @@ -176,7 +179,6 @@ * - country_code * - province_code * - postal_expression - * - id * properties: * type: * type: string @@ -185,7 +187,6 @@ * metadata: * type: object * description: The geo zone's metadata. - * properties: {} * city: * type: string * title: city @@ -201,7 +202,6 @@ * postal_expression: * type: object * description: The geo zone's postal expression. - * properties: {} * id: * type: string * title: id @@ -218,8 +218,7 @@ * -H 'Content-Type: application/json' \ * * --data-raw '{ - * "name": "Walker", - * "geo_zones": [] + * "name": "Elvis" * }' * tags: * - Fulfillment Sets diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts index 709b1927d8..45cff3f384 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,154 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - location_id - * - provider_id - * - delivery_address - * - items - * - labels - * - order - * - metadata - * properties: - * location_id: - * type: string - * title: location_id - * description: The fulfillment's location id. - * provider_id: - * type: string - * title: provider_id - * description: The fulfillment's provider id. - * delivery_address: - * type: object - * description: The fulfillment's delivery address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata - * properties: - * first_name: - * type: string - * title: first_name - * description: The delivery address's first name. - * last_name: - * type: string - * title: last_name - * description: The delivery address's last name. - * phone: - * type: string - * title: phone - * description: The delivery address's phone. - * company: - * type: string - * title: company - * description: The delivery address's company. - * address_1: - * type: string - * title: address_1 - * description: The delivery address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The delivery address's address 2. - * city: - * type: string - * title: city - * description: The delivery address's city. - * country_code: - * type: string - * title: country_code - * description: The delivery address's country code. - * province: - * type: string - * title: province - * description: The delivery address's province. - * postal_code: - * type: string - * title: postal_code - * description: The delivery address's postal code. - * metadata: - * type: object - * description: The delivery address's metadata. - * properties: {} - * items: - * type: array - * description: The fulfillment's items. - * items: - * type: object - * description: The item's items. - * required: - * - title - * - sku - * - quantity - * - barcode - * - line_item_id - * - inventory_item_id - * properties: - * title: - * type: string - * title: title - * description: The item's title. - * sku: - * type: string - * title: sku - * description: The item's sku. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * barcode: - * type: string - * title: barcode - * description: The item's barcode. - * line_item_id: - * type: string - * title: line_item_id - * description: The item's line item id. - * inventory_item_id: - * type: string - * title: inventory_item_id - * description: The item's inventory item id. - * labels: - * type: array - * description: The fulfillment's labels. - * items: - * type: object - * description: The label's labels. - * required: - * - tracking_number - * - tracking_url - * - label_url - * properties: - * tracking_number: - * type: string - * title: tracking_number - * description: The label's tracking number. - * tracking_url: - * type: string - * title: tracking_url - * description: The label's tracking url. - * label_url: - * type: string - * title: label_url - * description: The label's label url. - * order: - * type: object - * description: The fulfillment's order. - * properties: {} - * metadata: - * type: object - * description: The fulfillment's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateFulfillment" * x-codeSamples: * - lang: Shell * label: cURL @@ -228,7 +91,7 @@ * { * "title": "{value}", * "sku": "{value}", - * "quantity": 6350536800468992, + * "quantity": 1667318922870784, * "barcode": "{value}", * "line_item_id": "{value}", * "inventory_item_id": "{value}" @@ -242,11 +105,20 @@ * } * ], * "order": {}, + * "order_id": "{value}", + * "shipping_option_id": "{value}", + * "data": {}, + * "packed_at": "2024-11-12T18:37:37.122Z", + * "shipped_at": "2025-04-13T12:39:42.432Z", + * "delivered_at": "2025-01-29T19:05:57.056Z", + * "canceled_at": "2025-02-16T02:12:11.763Z", * "metadata": {} * }' * tags: * - Fulfillments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts index 7986e92d5d..9ec25cb7cf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,9 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * properties: {} + * $ref: "#/components/schemas/AdminCancelFulfillment" * x-codeSamples: * - lang: Shell * label: cURL @@ -71,6 +79,8 @@ * tags: * - Fulfillments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index 15e79078da..c01b4de29e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,34 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - labels - * properties: - * labels: - * type: array - * description: The fulfillment's labels. - * items: - * type: object - * description: The label's labels. - * required: - * - tracking_number - * - tracking_url - * - label_url - * properties: - * tracking_number: - * type: string - * title: tracking_number - * description: The label's tracking number. - * tracking_url: - * type: string - * title: tracking_url - * description: The label's tracking url. - * label_url: - * type: string - * title: label_url - * description: The label's label url. + * $ref: "#/components/schemas/AdminCreateShipment" * x-codeSamples: * - lang: Shell * label: cURL @@ -106,6 +89,8 @@ * tags: * - Fulfillments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts index 6021a3c786..5ffc4bd26b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -55,6 +65,20 @@ * 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 @@ -100,6 +124,10 @@ * 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 @@ -107,35 +135,54 @@ * metadata: * type: object * description: The inventory item's metadata. - * properties: {} - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The inventory item's requires shipping. - * required: - * - sku - * - hs_code - * - weight - * - length - * - height - * - width - * - origin_country - * - mid_code - * - material - * - title - * - description - * - requires_shipping - * - thumbnail - * - 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. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/inventory-items' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "sku": "{value}", + * "hs_code": "{value}", + * "weight": 2857134683324416, + * "length": 2322256963305472, + * "height": 8391220613087232, + * "width": 1297863250280448, + * "origin_country": "{value}", + * "mid_code": "{value}", + * "material": "{value}", + * "title": "{value}", + * "description": "{value}", + * "thumbnail": "{value}", + * "metadata": {} + * }' * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts index 2b71b3c274..f475755d39 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -61,63 +71,6 @@ * schema: * type: object * description: SUMMARY - * properties: - * sku: - * type: string - * title: sku - * description: The inventory item's sku. - * origin_country: - * type: string - * title: origin_country - * description: The inventory item's origin country. - * hs_code: - * type: string - * title: hs_code - * description: The inventory item's hs code. - * 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. - * weight: - * type: number - * title: weight - * description: The inventory item's weight. - * height: - * type: number - * title: height - * description: The inventory item's height. - * length: - * type: number - * title: length - * description: The inventory item's length. - * width: - * type: number - * title: width - * description: The inventory item's width. - * title: - * type: string - * title: title - * description: The inventory item's title. - * description: - * type: string - * title: description - * description: The inventory item's description. - * thumbnail: - * type: string - * title: thumbnail - * description: The inventory item's thumbnail. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The inventory item's requires shipping. - * metadata: - * type: object - * description: The inventory item's metadata. - * properties: {} * required: * - sku * - hs_code @@ -130,18 +83,91 @@ * - material * - title * - description - * - requires_shipping * - 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. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/inventory-items/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "sku": "{value}", + * "hs_code": "{value}", + * "weight": 8979922215239680, + * "length": 667491233693696, + * "height": 6328111551479808, + * "width": 7175104570064896, + * "origin_country": "{value}", + * "mid_code": "{value}", + * "material": "{value}", + * "title": "{value}", + * "description": "{value}", + * "thumbnail": "{value}", + * "metadata": {} + * }' * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index a0a6859de4..f79b191f25 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -63,8 +73,6 @@ * description: SUMMARY * required: * - location_id - * - stocked_quantity - * - incoming_quantity * properties: * location_id: * type: string @@ -86,12 +94,13 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "location_id": "{value}", - * "stocked_quantity": 1506469662949376 + * "location_id": "{value}" * }' * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index c00811b9fd..b5d11aaab8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,12 +57,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -68,17 +78,14 @@ * type: object * description: SUMMARY * properties: - * incoming_quantity: - * type: number - * title: incoming_quantity - * description: The inventory item's incoming quantity. * stocked_quantity: * type: number * title: stocked_quantity * description: The inventory item's stocked quantity. - * required: - * - stocked_quantity - * - incoming_quantity + * incoming_quantity: + * type: number + * title: incoming_quantity + * description: The inventory item's incoming quantity. * x-codeSamples: * - lang: Shell * label: cURL @@ -90,6 +97,8 @@ * tags: * - Inventory Items * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts index ae0b5caa65..7c02af0dd8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,39 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: >- - * curl -X POST - * '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ - * - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Inventory Items - * responses: - * "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" * requestBody: * content: * application/json: @@ -93,8 +80,6 @@ * description: The create's details. * required: * - location_id - * - stocked_quantity - * - incoming_quantity * properties: * location_id: * type: string @@ -114,9 +99,6 @@ * items: * type: object * description: The update's details. - * required: - * - stocked_quantity - * - incoming_quantity * properties: * stocked_quantity: * type: number @@ -133,6 +115,31 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/inventory-items/{id}/location-levels/batch' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Inventory Items + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index 13d92cf7cb..07116cc746 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -3,7 +3,7 @@ * operationId: PostInvites * summary: Create Invite * description: Create a invite. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,16 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * requestBody: * content: * application/json: @@ -68,14 +74,15 @@ * label: cURL * source: |- * curl -X POST '{backend_url}/admin/invites' \ - * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "email": "Abdiel5@gmail.com" + * "email": "Whitney_Schultz@gmail.com" * }' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts index 6219f43bc7..5c610118ec 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_[id]_resend.ts @@ -3,7 +3,7 @@ * operationId: PostInvitesIdResend * summary: Add Resends to Invite * description: Add a list of resends to a invite. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/invites/{id}/resend' \ - * -H 'x-medusa-access-token: {api_token}' + * source: curl -X POST '{backend_url}/admin/invites/{id}/resend' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +82,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index 6e7075632d..b99fbde09e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -3,7 +3,7 @@ * operationId: PostInvitesAccept * summary: Create Invite * description: Create a invite. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,16 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * requestBody: * content: * application/json: @@ -60,6 +66,11 @@ * - first_name * - last_name * properties: + * email: + * type: string + * title: email + * description: The invite's email. + * format: email * first_name: * type: string * title: first_name @@ -68,25 +79,22 @@ * type: string * title: last_name * description: The invite's last name. - * email: - * type: string - * title: email - * description: The invite's email. - * format: email * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/invites/accept' \ - * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ + * "email": "Lila_Zemlak@hotmail.com", * "first_name": "{value}", * "last_name": "{value}" * }' * tags: * - Invites * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts similarity index 59% rename from www/utils/generated/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts rename to www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts index 9b7dee0591..84fbae4c8a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id].ts @@ -1,14 +1,13 @@ /** - * @oas [delete] /admin/pricing/rule-types/{id} - * operationId: DeletePricingRuleTypesId - * summary: Remove Rule Types from Pricing - * description: Remove a list of rule types from a pricing. This doesn't delete the - * Rule Type, only the association between the Rule Type and the pricing. + * @oas [post] /admin/orders/{id} + * operationId: PostOrdersId + * summary: Update a Order + * description: Update a order's details. * x-authenticated: true * parameters: * - name: id * in: path - * description: The pricing's ID. + * description: The order's ID. * required: true * schema: * type: string @@ -22,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,31 +51,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * description: SUMMARY - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl -X DELETE '{backend_url}/admin/pricing/rule-types/{id}' \ + * curl -X POST '{backend_url}/admin/orders/{id}' \ * -H 'x-medusa-access-token: {api_token}' * tags: - * - Pricing + * - Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts new file mode 100644 index 0000000000..36bfd5fe11 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/orders/{id}/archive + * operationId: PostOrdersIdArchive + * summary: Add Archives to Order + * description: Add a list of archives to a order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminArchiveOrder" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}/archive' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}" + * }' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts similarity index 58% rename from www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts rename to www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts index b3e6473836..09990dd391 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_cancel.ts @@ -1,13 +1,13 @@ /** - * @oas [post] /admin/pricing/rule-types/{id} - * operationId: PostPricingRuleTypesId - * summary: Add Rule Types to Pricing - * description: Add a list of rule types to a pricing. + * @oas [post] /admin/orders/{id}/cancel + * operationId: PostOrdersIdCancel + * summary: Add Cancels to Order + * description: Add a list of cancels to a order. * x-authenticated: true * parameters: * - name: id * in: path - * description: The pricing's ID. + * description: The order's ID. * required: true * schema: * type: string @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,48 +51,31 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * properties: - * name: - * type: string - * title: name - * description: The pricing's name. - * rule_attribute: - * type: string - * title: rule_attribute - * description: The pricing's rule attribute. - * default_priority: - * type: number - * title: default_priority - * description: The pricing's default priority. - * required: - * - name - * - rule_attribute - * - default_priority * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl -X POST '{backend_url}/admin/pricing/rule-types/{id}' \ + * curl -X POST '{backend_url}/admin/orders/{id}/cancel' \ * -H 'x-medusa-access-token: {api_token}' * tags: - * - Pricing + * - Orders * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts new file mode 100644 index 0000000000..3a40aee48e --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -0,0 +1,102 @@ +/** + * @oas [post] /admin/orders/{id}/complete + * operationId: PostOrdersIdComplete + * summary: Add Completes to Order + * description: Add a list of completes to a order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCompleteOrder" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}/complete' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}" + * }' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts new file mode 100644 index 0000000000..43e2af131d --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -0,0 +1,109 @@ +/** + * @oas [post] /admin/orders/{id}/fulfillments + * operationId: PostOrdersIdFulfillments + * summary: Add Fulfillments to Order + * description: Add a list of fulfillments to a order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderCreateFulfillment" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/orders/{id}/fulfillments' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "items": [ + * { + * "id": "id_YePfQ6PBCBKvmYyreUt2", + * "quantity": 6623610359775232 + * } + * ], + * "location_id": "{value}", + * "metadata": {} + * }' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts new file mode 100644 index 0000000000..c7f1a57f81 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -0,0 +1,106 @@ +/** + * @oas [post] /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel + * operationId: PostOrdersIdFulfillmentsFulfillment_idCancel + * summary: Add Cancels to Order + * description: Add a list of cancels to a order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: fulfillment_id + * in: path + * description: The order's fulfillment id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderCancelFulfillment" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/cancel' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipment.ts new file mode 100644 index 0000000000..f610d6bbd1 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipment.ts @@ -0,0 +1,118 @@ +/** + * @oas [post] /admin/orders/{id}/fulfillments/{fulfillment_id}/shipment + * operationId: PostOrdersIdFulfillmentsFulfillment_idShipment + * summary: Add Shipments to Order + * description: Add a list of shipments to a order. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: fulfillment_id + * in: path + * description: The order's fulfillment id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminOrderCreateShipment" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/shipment' \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "items": [ + * { + * "id": "id_eyih2debIPWMK4kaHGPZ", + * "quantity": 7476297089417216 + * } + * ], + * "metadata": {} + * }' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index 113d1f6fe5..1d6be2564d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -66,8 +76,6 @@ * type: number * title: amount * description: The payment's amount. - * required: - * - amount * x-codeSamples: * - lang: Shell * label: cURL @@ -77,6 +85,8 @@ * tags: * - Payments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index c0bd4ec85d..9f8abe14e3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -66,8 +76,6 @@ * type: number * title: amount * description: The payment's amount. - * required: - * - amount * x-codeSamples: * - lang: Shell * label: cURL @@ -77,6 +85,8 @@ * tags: * - Payments * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index 2809e51123..c04a66aa59 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,86 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - description - * - starts_at - * - ends_at - * - status - * - type - * - rules - * - prices - * properties: - * title: - * type: string - * title: title - * description: The price list's title. - * description: - * type: string - * title: description - * description: The price list's description. - * starts_at: - * type: string - * title: starts_at - * description: The price list's starts at. - * ends_at: - * type: string - * title: ends_at - * description: The price list's ends at. - * status: - * enum: - * - active - * - draft - * type: string - * type: - * enum: - * - sale - * - override - * type: string - * prices: - * type: array - * description: The price list's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - currency_code - * - amount - * - variant_id - * - min_quantity - * - max_quantity - * - rules - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * variant_id: - * type: string - * title: variant_id - * description: The price's variant id. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * rules: - * type: object - * description: The price's rules. - * properties: {} - * rules: - * type: object - * description: The price list's rules. - * properties: {} + * $ref: "#/components/schemas/AdminCreatePriceList" * x-codeSamples: * - lang: Shell * label: cURL @@ -143,17 +74,14 @@ * --data-raw '{ * "title": "{value}", * "description": "{value}", - * "prices": [ - * { - * "currency_code": "{value}", - * "amount": 1270314195484672, - * "variant_id": "{value}" - * } - * ] + * "starts_at": "{value}", + * "ends_at": "{value}" * }' * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts index 4c3d9dfaf2..bd5a47eb3b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,47 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - description - * - starts_at - * - ends_at - * - status - * - type - * - rules - * properties: - * title: - * type: string - * title: title - * description: The price list's title. - * description: - * type: string - * title: description - * description: The price list's description. - * starts_at: - * type: string - * title: starts_at - * description: The price list's starts at. - * ends_at: - * type: string - * title: ends_at - * description: The price list's ends at. - * status: - * enum: - * - active - * - draft - * type: string - * type: - * enum: - * - sale - * - override - * type: string - * rules: - * type: object - * description: The price list's rules. - * properties: {} + * $ref: "#/components/schemas/AdminUpdatePriceList" * x-codeSamples: * - lang: Shell * label: cURL @@ -108,17 +78,15 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "prices": [ - * { - * "currency_code": "{value}", - * "amount": 1670236243755008, - * "variant_id": "{value}" - * } - * ] + * "description": "{value}", + * "starts_at": "{value}", + * "ends_at": "{value}" * }' * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts index 7a3bfeff7f..097da7860d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,37 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Price Lists - * responses: - * "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" * requestBody: * content: * application/json: @@ -95,7 +84,6 @@ * - variant_id * - min_quantity * - max_quantity - * - rules * properties: * currency_code: * type: string @@ -120,7 +108,6 @@ * rules: * type: object * description: The create's rules. - * properties: {} * update: * type: array * description: The price list's update. @@ -129,12 +116,9 @@ * description: The update's details. * required: * - id - * - currency_code - * - amount * - variant_id * - min_quantity * - max_quantity - * - rules * properties: * id: * type: string @@ -163,7 +147,6 @@ * rules: * type: object * description: The update's rules. - * properties: {} * delete: * type: array * description: The price list's delete. @@ -171,6 +154,29 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/price-lists/{id}/prices/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Price Lists + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts index a72c273238..5e3da3d236 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Price Lists * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 5afd98bdab..9d9519628f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -57,13 +67,8 @@ * description: SUMMARY * required: * - name - * - description - * - handle - * - is_internal - * - is_active * - parent_category_id * - metadata - * - rank * properties: * name: * type: string @@ -92,7 +97,6 @@ * metadata: * type: object * description: The product category's metadata. - * properties: {} * rank: * type: number * title: rank @@ -105,14 +109,9 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Laurel", - * "description": "{value}", - * "handle": "{value}", - * "is_internal": true, - * "is_active": true, + * "name": "Vesta", * "parent_category_id": "{value}", - * "metadata": {}, - * "rank": 8919807883739136 + * "metadata": {} * }' * tags: * - Product Categories diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 0370fefdff..d44e39e666 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -62,14 +72,8 @@ * type: object * description: SUMMARY * required: - * - name - * - description - * - handle - * - is_internal - * - is_active * - parent_category_id * - metadata - * - rank * properties: * name: * type: string @@ -98,7 +102,6 @@ * metadata: * type: object * description: The product category's metadata. - * properties: {} * rank: * type: number * title: rank @@ -111,14 +114,8 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Xzavier", - * "description": "{value}", - * "handle": "{value}", - * "is_internal": true, - * "is_active": true, * "parent_category_id": "{value}", - * "metadata": {}, - * "rank": 6601863235371008 + * "metadata": {} * }' * tags: * - Product Categories diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index 49572ddf9c..3fba2f1a80 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +51,41 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * add: + * type: array + * description: The product category's add. + * items: + * type: string + * title: add + * description: The add's details. + * remove: + * type: array + * description: The product category's remove. + * items: + * type: string + * title: remove + * description: The remove's details. * x-codeSamples: * - lang: Shell * label: cURL @@ -82,27 +113,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * properties: - * add: - * type: array - * description: The product category's add. - * items: - * type: string - * title: add - * description: The add's details. - * remove: - * type: array - * description: The product category's remove. - * items: - * type: string - * title: remove - * description: The remove's details. * */ diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts similarity index 51% rename from www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types.ts rename to www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts index 9aa6fc1881..1c56fd2e39 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_pricing_rule-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts @@ -1,9 +1,8 @@ /** - * @oas [get] /admin/pricing/rule-types - * operationId: GetPricingRuleTypes - * summary: List Pricing - * description: Retrieve a list of pricing. The pricing can be filtered by fields - * such as `id`. The pricing can also be sorted or paginated. + * @oas [post] /admin/product-tags + * operationId: PostProductTags + * summary: Create Product Tag + * description: Create a product tag. * x-authenticated: true * parameters: * - name: expand @@ -16,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -54,44 +63,35 @@ * content: * application/json: * schema: + * type: object * description: SUMMARY + * required: + * - value + * - metadata * properties: - * rule_attribute: - * type: array - * description: The pricing's rule attribute. - * items: - * type: string - * title: rule_attribute - * description: The rule attribute's details. - * expand: + * value: * type: string - * title: expand - * description: The pricing's expand. - * fields: - * type: string - * title: fields - * description: The pricing's fields. - * offset: - * type: number - * title: offset - * description: The pricing's offset. - * limit: - * type: number - * title: limit - * description: The pricing's limit. - * order: - * type: string - * title: order - * description: The pricing's order. + * title: value + * description: The product tag's value. + * metadata: + * type: object + * description: The product tag's metadata. * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl '{backend_url}/admin/pricing/rule-types' \ - * -H 'x-medusa-access-token: {api_token}' + * curl -X POST '{backend_url}/admin/product-tags' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "value": "{value}", + * "metadata": {} + * }' * tags: - * - Pricing + * - Product Tags * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts new file mode 100644 index 0000000000..79fcb2cbcb --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts @@ -0,0 +1,113 @@ +/** + * @oas [post] /admin/product-tags/{id} + * operationId: PostProductTagsId + * summary: Update a Product Tag + * description: Update a product tag's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product tag's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - metadata + * properties: + * value: + * type: string + * title: value + * description: The product tag's value. + * metadata: + * type: object + * description: The product tag's metadata. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/product-tags/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "metadata": {} + * }' + * tags: + * - Product Tags + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts index ab3c4ccf57..79891d4ad4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -66,7 +76,6 @@ * metadata: * type: object * description: The product type's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -81,6 +90,8 @@ * tags: * - Product Types * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts index 69c3be95f2..b5f3cd54b8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -62,7 +72,6 @@ * type: object * description: SUMMARY * required: - * - value * - metadata * properties: * value: @@ -72,7 +81,6 @@ * metadata: * type: object * description: The product type's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -81,12 +89,13 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "value": "{value}", * "metadata": {} * }' * tags: * - Product Types * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index 89d8b49939..6d5258c618 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,324 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - subtitle - * - description - * - is_giftcard - * - discountable - * - images - * - thumbnail - * - handle - * - status - * - type_id - * - collection_id - * - categories - * - tags - * - options - * - variants - * - sales_channels - * - weight - * - length - * - height - * - width - * - hs_code - * - mid_code - * - origin_country - * - material - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * description: - * type: string - * title: description - * description: The product's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The product's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * images: - * type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * handle: - * type: string - * title: handle - * description: The product's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * - value - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * options: - * type: array - * description: The product's options. - * items: - * type: object - * description: The option's options. - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * variants: - * type: array - * description: The product's variants. - * items: - * type: object - * description: The variant's variants. - * required: - * - title - * - sku - * - ean - * - upc - * - barcode - * - hs_code - * - mid_code - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * - variant_rank - * - weight - * - length - * - height - * - width - * - origin_country - * - material - * - metadata - * - prices - * - options - * properties: - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The variant's variant rank. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * material: - * type: string - * title: material - * description: The variant's material. - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * prices: - * type: array - * description: The variant's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - currency_code - * - amount - * - min_quantity - * - max_quantity - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * options: - * type: object - * description: The variant's options. - * properties: {} - * sales_channels: - * type: array - * description: The product's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateProduct" * x-codeSamples: * - lang: Shell * label: cURL @@ -379,89 +72,17 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "title": "{value}", - * "subtitle": "{value}", - * "description": "{value}", - * "is_giftcard": false, - * "discountable": false, - * "images": [ - * { - * "url": "{value}" - * } - * ], - * "thumbnail": "{value}", - * "handle": "{value}", - * "status": "{value}", - * "type_id": "{value}", - * "collection_id": "{value}", - * "categories": [ - * { - * "id": "id_Pb7xedYA7ZAv6g6j54ew" - * } - * ], - * "tags": [ - * { - * "id": "id_oDxag4mAGc8CJc", - * "value": "{value}" - * } - * ], - * "options": [ - * { - * "title": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ], - * "variants": [ - * { - * "title": "{value}", - * "sku": "{value}", - * "ean": "{value}", - * "upc": "{value}", - * "barcode": "{value}", - * "hs_code": "{value}", - * "mid_code": "{value}", - * "inventory_quantity": 1351101225893888, - * "allow_backorder": true, - * "manage_inventory": true, - * "variant_rank": 7155606282567680, - * "weight": 4684377097240576, - * "length": 8061605384290304, - * "height": 977445643616256, - * "width": 6708177689116672, - * "origin_country": "{value}", - * "material": "{value}", - * "metadata": {}, - * "prices": [ - * { - * "currency_code": "{value}", - * "amount": 4139683418210304, - * "min_quantity": 8440994678702080, - * "max_quantity": 5266280927985664 - * } - * ], - * "options": {} - * } - * ], - * "sales_channels": [ - * { - * "id": "id_WJNcwOGY7glMp" - * } - * ], - * "weight": 8634028928270336, - * "length": 2270965595635712, - * "height": 216881319378944, - * "width": 7665967272296448, - * "hs_code": "{value}", - * "mid_code": "{value}", - * "origin_country": "{value}", - * "material": "{value}", - * "metadata": {} + * "title": "{value}" * }' * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index cade35e1bd..c216c6e38e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,427 +69,22 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - length - * - description - * - handle - * - metadata - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - thumbnail - * - collection_id - * - tags - * - type_id - * - subtitle - * - images - * - categories - * - sales_channels - * - title - * - discountable - * - options - * - variants - * - status - * properties: - * length: - * type: number - * title: length - * description: The product's length. - * description: - * type: string - * title: description - * description: The product's description. - * handle: - * type: string - * title: handle - * description: The product's handle. - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * weight: - * type: number - * title: weight - * description: The product's weight. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * material: - * type: string - * title: material - * description: The product's material. - * thumbnail: - * type: string - * title: thumbnail - * description: The product's thumbnail. - * collection_id: - * type: string - * title: collection_id - * description: The product's collection id. - * tags: - * type: array - * description: The product's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * - value - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * type_id: - * type: string - * title: type_id - * description: The product's type id. - * subtitle: - * type: string - * title: subtitle - * description: The product's subtitle. - * images: - * type: array - * description: The product's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * categories: - * type: array - * description: The product's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * sales_channels: - * type: array - * description: The product's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * title: - * type: string - * title: title - * description: The product's title. - * discountable: - * type: boolean - * title: discountable - * description: The product's discountable. - * options: - * type: array - * description: The product's options. - * items: - * type: object - * description: The option's options. - * required: - * - id - * - title - * - values - * properties: - * id: - * type: string - * title: id - * description: The option's ID. - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * variants: - * type: array - * description: The product's variants. - * items: - * type: object - * description: The variant's variants. - * required: - * - length - * - options - * - metadata - * - sku - * - barcode - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - ean - * - upc - * - variant_rank - * - id - * - title - * - prices - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * properties: - * length: - * type: number - * title: length - * description: The variant's length. - * options: - * type: object - * description: The variant's options. - * properties: {} - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * sku: - * type: string - * title: sku - * description: The variant's sku. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * material: - * type: string - * title: material - * description: The variant's material. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * variant_rank: - * type: number - * title: variant_rank - * description: The variant's variant rank. - * id: - * type: string - * title: id - * description: The variant's ID. - * title: - * type: string - * title: title - * description: The variant's title. - * prices: - * type: array - * description: The variant's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - id - * - currency_code - * - amount - * - min_quantity - * - max_quantity - * properties: - * id: - * type: string - * title: id - * description: The price's ID. - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected + * $ref: "#/components/schemas/AdminUpdateProduct" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/products/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "length": 3282567029587968, - * "description": "{value}", - * "handle": "{value}", - * "metadata": {}, - * "hs_code": "{value}", - * "weight": 4215232060719104, - * "height": 6855525188763648, - * "width": 6565860296622080, - * "origin_country": "{value}", - * "mid_code": "{value}", - * "material": "{value}", - * "thumbnail": "{value}", - * "collection_id": "{value}", - * "tags": [ - * { - * "id": "id_ufkiM27SGLcGKiI9fx7h", - * "value": "{value}" - * } - * ], - * "type_id": "{value}", - * "subtitle": "{value}", - * "images": [ - * { - * "url": "{value}" - * } - * ], - * "categories": [ - * { - * "id": "id_Je6uOboEms3Pkb0s14SZ" - * } - * ], - * "sales_channels": [ - * { - * "id": "id_ttuXRM0VhnlxO0tg061" - * } - * ], - * "title": "{value}", - * "discountable": true, - * "options": [ - * { - * "id": "id_2B9lNIRdze", - * "title": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ], - * "variants": [ - * { - * "length": 7973681567367168, - * "options": {}, - * "metadata": {}, - * "sku": "{value}", - * "barcode": "{value}", - * "hs_code": "{value}", - * "weight": 815881462480896, - * "height": 3071682140962816, - * "width": 1867897194414080, - * "origin_country": "{value}", - * "mid_code": "{value}", - * "material": "{value}", - * "ean": "{value}", - * "upc": "{value}", - * "variant_rank": 6253314014445568, - * "id": "id_QiUPVfomSLnRRU", - * "title": "{value}", - * "prices": [ - * { - * "id": "id_KIf1hFOhE2", - * "currency_code": "{value}", - * "amount": 7111166155292672, - * "min_quantity": 7445498468237312, - * "max_quantity": 7312473510117376 - * } - * ], - * "inventory_quantity": 3277737491955712, - * "allow_backorder": false, - * "manage_inventory": true - * } - * ], - * "status": "{value}" - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index e74c5e4386..9f49dc4897 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,23 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * values: - * type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. + * $ref: "#/components/schemas/AdminCreateProductOption" * x-codeSamples: * - lang: Shell * label: cURL @@ -92,6 +86,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index 28b1cca985..fcc71e574d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,12 +57,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,45 +75,22 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - id - * - title - * - values - * properties: - * id: - * type: string - * title: id - * description: The product's ID. - * title: - * type: string - * title: title - * description: The product's title. - * values: - * type: array - * description: The product's values. - * items: - * type: string - * title: values - * description: The value's values. + * $ref: "#/components/schemas/AdminUpdateProductOption" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/products/{id}/options/{option_id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "id": "id_BdxJWBRNOp", - * "title": "{value}", - * "values": [ - * "{value}" - * ] - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index 43198e4c41..e132398e46 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,134 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - title - * - sku - * - ean - * - upc - * - barcode - * - hs_code - * - mid_code - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * - variant_rank - * - weight - * - length - * - height - * - width - * - origin_country - * - material - * - metadata - * - prices - * - options - * properties: - * title: - * type: string - * title: title - * description: The product's title. - * sku: - * type: string - * title: sku - * description: The product's sku. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The product's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The product's variant rank. - * weight: - * type: number - * title: weight - * description: The product's weight. - * length: - * type: number - * title: length - * description: The product's length. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * material: - * type: string - * title: material - * description: The product's material. - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * prices: - * type: array - * description: The product's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - currency_code - * - amount - * - min_quantity - * - max_quantity - * properties: - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * options: - * type: object - * description: The product's options. - * properties: {} + * $ref: "#/components/schemas/AdminCreateProductVariant" * x-codeSamples: * - lang: Shell * label: cURL @@ -196,36 +79,17 @@ * -H 'Content-Type: application/json' \ * --data-raw '{ * "title": "{value}", - * "sku": "{value}", - * "ean": "{value}", - * "upc": "{value}", - * "barcode": "{value}", - * "hs_code": "{value}", - * "mid_code": "{value}", - * "inventory_quantity": 3621544083324928, - * "allow_backorder": false, - * "manage_inventory": true, - * "variant_rank": 849570489696256, - * "weight": 7893319220723712, - * "length": 2949835917361152, - * "height": 2357674687594496, - * "width": 5150499311452160, - * "origin_country": "{value}", - * "material": "{value}", - * "metadata": {}, - * "prices": [ - * { - * "currency_code": "{value}", - * "amount": 8952600449777664, - * "min_quantity": 5462512040411136, - * "max_quantity": 4871260370632704 - * } - * ], - * "options": {} + * "prices": [] * }' * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index 199c9efa78..e4475907ff 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,12 +57,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -65,185 +75,22 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - length - * - options - * - metadata - * - sku - * - barcode - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - ean - * - upc - * - variant_rank - * - id - * - title - * - prices - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * properties: - * length: - * type: number - * title: length - * description: The product's length. - * options: - * type: object - * description: The product's options. - * properties: {} - * metadata: - * type: object - * description: The product's metadata. - * properties: {} - * sku: - * type: string - * title: sku - * description: The product's sku. - * barcode: - * type: string - * title: barcode - * description: The product's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The product's hs code. - * weight: - * type: number - * title: weight - * description: The product's weight. - * height: - * type: number - * title: height - * description: The product's height. - * width: - * type: number - * title: width - * description: The product's width. - * origin_country: - * type: string - * title: origin_country - * description: The product's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The product's mid code. - * material: - * type: string - * title: material - * description: The product's material. - * ean: - * type: string - * title: ean - * description: The product's ean. - * upc: - * type: string - * title: upc - * description: The product's upc. - * variant_rank: - * type: number - * title: variant_rank - * description: The product's variant rank. - * id: - * type: string - * title: id - * description: The product's ID. - * title: - * type: string - * title: title - * description: The product's title. - * prices: - * type: array - * description: The product's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - id - * - currency_code - * - amount - * - min_quantity - * - max_quantity - * properties: - * id: - * type: string - * title: id - * description: The price's ID. - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The product's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The product's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The product's manage inventory. + * $ref: "#/components/schemas/AdminUpdateProductVariant" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "length": 553333433565184, - * "options": {}, - * "metadata": {}, - * "sku": "{value}", - * "barcode": "{value}", - * "hs_code": "{value}", - * "weight": 110229628911616, - * "height": 4172081795170304, - * "width": 2991320977113088, - * "origin_country": "{value}", - * "mid_code": "{value}", - * "material": "{value}", - * "ean": "{value}", - * "upc": "{value}", - * "variant_rank": 3522258324684800, - * "id": "id_bPPvwOwWIa2ndex", - * "title": "{value}", - * "prices": [ - * { - * "id": "id_gGmeMrUwBNt", - * "currency_code": "{value}", - * "amount": 4572898136162304, - * "min_quantity": 6709305447284736, - * "max_quantity": 2556752140697600 - * } - * ], - * "inventory_quantity": 7991114464231424, - * "allow_backorder": false, - * "manage_inventory": true - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts new file mode 100644 index 0000000000..856c73897e --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts @@ -0,0 +1,114 @@ +/** + * @oas [post] /admin/products/{id}/variants/{variant_id}/inventory-items + * operationId: PostProductsIdVariantsVariant_idInventoryItems + * summary: Add Inventory Items to Product + * description: Add a list of inventory items to a product. + * 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's variant id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCreateVariantInventoryItem" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "required_quantity": 7390879820021760, + * "inventory_item_id": "{value}" + * }' + * tags: + * - Products + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts new file mode 100644 index 0000000000..3ae0254500 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -0,0 +1,119 @@ +/** + * @oas [post] /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id} + * operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id + * summary: Add Inventory Items to Product + * description: Add a list of inventory items to a product. + * 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's variant id. + * required: true + * schema: + * type: string + * - name: inventory_item_id + * in: path + * description: The product's inventory item id. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateVariantInventoryItem" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}' + * \ + * + * -H 'x-medusa-access-token: {api_token}' \ + * + * -H 'Content-Type: application/json' \ + * + * --data-raw '{ + * "required_quantity": 5324804697620480 + * }' + * tags: + * - Products + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts index db577e5dcf..d9eb15bd2c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,16 +51,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchProductVariantRequest" * x-codeSamples: * - lang: Shell * label: cURL @@ -64,6 +79,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchProductVariantResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,463 +97,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * properties: - * create: - * type: array - * description: The product's create. - * items: - * type: object - * description: The create's details. - * required: - * - title - * - subtitle - * - description - * - is_giftcard - * - discountable - * - images - * - thumbnail - * - handle - * - status - * - type_id - * - collection_id - * - categories - * - tags - * - options - * - variants - * - sales_channels - * - weight - * - length - * - height - * - width - * - hs_code - * - mid_code - * - origin_country - * - material - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The create's title. - * subtitle: - * type: string - * title: subtitle - * description: The create's subtitle. - * description: - * type: string - * title: description - * description: The create's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The create's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The create's discountable. - * images: - * type: array - * description: The create's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The create's thumbnail. - * handle: - * type: string - * title: handle - * description: The create's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type_id: - * type: string - * title: type_id - * description: The create's type id. - * collection_id: - * type: string - * title: collection_id - * description: The create's collection id. - * categories: - * type: array - * description: The create's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * tags: - * type: array - * description: The create's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * - value - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * options: - * type: array - * description: The create's options. - * items: - * type: object - * description: The option's options. - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * variants: - * type: array - * description: The create's variants. - * items: - * type: object - * description: The variant's variants. - * required: - * - title - * - sku - * - ean - * - upc - * - barcode - * - hs_code - * - mid_code - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * - variant_rank - * - weight - * - length - * - height - * - width - * - origin_country - * - material - * - metadata - * - prices - * - options - * properties: - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The variant's variant rank. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * material: - * type: string - * title: material - * description: The variant's material. - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * prices: - * type: array - * description: The variant's prices. - * items: - * type: object - * description: The price's prices. - * properties: {} - * options: - * type: object - * description: The variant's options. - * properties: {} - * sales_channels: - * type: array - * description: The create's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * weight: - * type: number - * title: weight - * description: The create's weight. - * length: - * type: number - * title: length - * description: The create's length. - * height: - * type: number - * title: height - * description: The create's height. - * width: - * type: number - * title: width - * description: The create's width. - * hs_code: - * type: string - * title: hs_code - * description: The create's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The create's mid code. - * origin_country: - * type: string - * title: origin_country - * description: The create's origin country. - * material: - * type: string - * title: material - * description: The create's material. - * metadata: - * type: object - * description: The create's metadata. - * properties: {} - * update: - * type: array - * description: The product's update. - * items: - * type: object - * description: The update's details. - * required: - * - title - * - length - * - options - * - metadata - * - sku - * - barcode - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - prices - * - manage_inventory - * - allow_backorder - * - ean - * - upc - * - inventory_quantity - * - variant_rank - * - id - * properties: - * title: - * type: string - * title: title - * description: The update's title. - * length: - * type: number - * title: length - * description: The update's length. - * options: - * type: object - * description: The update's options. - * properties: {} - * metadata: - * type: object - * description: The update's metadata. - * properties: {} - * sku: - * type: string - * title: sku - * description: The update's sku. - * barcode: - * type: string - * title: barcode - * description: The update's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The update's hs code. - * weight: - * type: number - * title: weight - * description: The update's weight. - * height: - * type: number - * title: height - * description: The update's height. - * width: - * type: number - * title: width - * description: The update's width. - * origin_country: - * type: string - * title: origin_country - * description: The update's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The update's mid code. - * material: - * type: string - * title: material - * description: The update's material. - * prices: - * type: array - * description: The update's prices. - * items: - * type: object - * description: The price's prices. - * required: - * - id - * - currency_code - * - amount - * - min_quantity - * - max_quantity - * properties: - * id: - * type: string - * title: id - * description: The price's ID. - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * amount: - * type: number - * title: amount - * description: The price's amount. - * min_quantity: - * type: number - * title: min_quantity - * description: The price's min quantity. - * max_quantity: - * type: number - * title: max_quantity - * description: The price's max quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The update's manage inventory. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The update's allow backorder. - * ean: - * type: string - * title: ean - * description: The update's ean. - * upc: - * type: string - * title: upc - * description: The update's upc. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The update's inventory quantity. - * variant_rank: - * type: number - * title: variant_rank - * description: The update's variant rank. - * id: - * type: string - * title: id - * description: The update's ID. - * delete: - * type: array - * description: The product's delete. - * items: - * type: string - * title: delete - * description: The delete's details. * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts new file mode 100644 index 0000000000..60200f4906 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_inventory-items_batch.ts @@ -0,0 +1,166 @@ +/** + * @oas [post] /admin/products/{id}/variants/inventory-items/batch + * operationId: PostProductsIdVariantsInventoryItemsBatch + * summary: Add Inventory Items to Product + * description: Add a list of inventory items to a product. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The product's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * properties: + * create: + * type: array + * description: The product's create. + * items: + * type: object + * description: The create's details. + * required: + * - required_quantity + * - inventory_item_id + * - variant_id + * properties: + * required_quantity: + * type: number + * title: required_quantity + * description: The create's required quantity. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The create's inventory item id. + * variant_id: + * type: string + * title: variant_id + * description: The create's variant id. + * update: + * type: array + * description: The product's update. + * items: + * type: object + * description: The update's details. + * required: + * - required_quantity + * - inventory_item_id + * - variant_id + * properties: + * required_quantity: + * type: number + * title: required_quantity + * description: The update's required quantity. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The update's inventory item id. + * variant_id: + * type: string + * title: variant_id + * description: The update's variant id. + * delete: + * type: array + * description: The product's delete. + * items: + * type: object + * description: The delete's details. + * required: + * - inventory_item_id + * - variant_id + * properties: + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The delete's inventory item id. + * variant_id: + * type: string + * title: variant_id + * description: The delete's variant id. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: >- + * curl -X POST + * '{backend_url}/admin/products/{id}/variants/inventory-items/batch' \ + * + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Products + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts index 02054f2fa3..83757ca792 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,16 +45,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchProductRequest" * x-codeSamples: * - lang: Shell * label: cURL @@ -58,6 +73,12 @@ * tags: * - Products * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminBatchProductResponse" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,632 +91,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * properties: - * create: - * type: array - * description: The product's create. - * items: - * type: object - * description: The create's details. - * required: - * - title - * - subtitle - * - description - * - is_giftcard - * - discountable - * - images - * - thumbnail - * - handle - * - status - * - type_id - * - collection_id - * - categories - * - tags - * - options - * - variants - * - sales_channels - * - weight - * - length - * - height - * - width - * - hs_code - * - mid_code - * - origin_country - * - material - * - metadata - * properties: - * title: - * type: string - * title: title - * description: The create's title. - * subtitle: - * type: string - * title: subtitle - * description: The create's subtitle. - * description: - * type: string - * title: description - * description: The create's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The create's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The create's discountable. - * images: - * type: array - * description: The create's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * thumbnail: - * type: string - * title: thumbnail - * description: The create's thumbnail. - * handle: - * type: string - * title: handle - * description: The create's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * type_id: - * type: string - * title: type_id - * description: The create's type id. - * collection_id: - * type: string - * title: collection_id - * description: The create's collection id. - * categories: - * type: array - * description: The create's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * tags: - * type: array - * description: The create's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * - value - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * options: - * type: array - * description: The create's options. - * items: - * type: object - * description: The option's options. - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * variants: - * type: array - * description: The create's variants. - * items: - * type: object - * description: The variant's variants. - * required: - * - title - * - sku - * - ean - * - upc - * - barcode - * - hs_code - * - mid_code - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * - variant_rank - * - weight - * - length - * - height - * - width - * - origin_country - * - material - * - metadata - * - prices - * - options - * properties: - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * variant_rank: - * type: number - * title: variant_rank - * description: The variant's variant rank. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * material: - * type: string - * title: material - * description: The variant's material. - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * prices: - * type: array - * description: The variant's prices. - * items: - * type: object - * description: The price's prices. - * properties: {} - * options: - * type: object - * description: The variant's options. - * properties: {} - * sales_channels: - * type: array - * description: The create's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * weight: - * type: number - * title: weight - * description: The create's weight. - * length: - * type: number - * title: length - * description: The create's length. - * height: - * type: number - * title: height - * description: The create's height. - * width: - * type: number - * title: width - * description: The create's width. - * hs_code: - * type: string - * title: hs_code - * description: The create's hs code. - * mid_code: - * type: string - * title: mid_code - * description: The create's mid code. - * origin_country: - * type: string - * title: origin_country - * description: The create's origin country. - * material: - * type: string - * title: material - * description: The create's material. - * metadata: - * type: object - * description: The create's metadata. - * properties: {} - * update: - * type: array - * description: The product's update. - * items: - * type: object - * description: The update's details. - * required: - * - title - * - status - * - length - * - options - * - description - * - handle - * - metadata - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - thumbnail - * - variants - * - collection_id - * - tags - * - type_id - * - subtitle - * - discountable - * - images - * - categories - * - sales_channels - * - id - * properties: - * title: - * type: string - * title: title - * description: The update's title. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * length: - * type: number - * title: length - * description: The update's length. - * options: - * type: array - * description: The update's options. - * items: - * type: object - * description: The option's options. - * required: - * - id - * - title - * - values - * properties: - * id: - * type: string - * title: id - * description: The option's ID. - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * description: - * type: string - * title: description - * description: The update's description. - * handle: - * type: string - * title: handle - * description: The update's handle. - * metadata: - * type: object - * description: The update's metadata. - * properties: {} - * hs_code: - * type: string - * title: hs_code - * description: The update's hs code. - * weight: - * type: number - * title: weight - * description: The update's weight. - * height: - * type: number - * title: height - * description: The update's height. - * width: - * type: number - * title: width - * description: The update's width. - * origin_country: - * type: string - * title: origin_country - * description: The update's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The update's mid code. - * material: - * type: string - * title: material - * description: The update's material. - * thumbnail: - * type: string - * title: thumbnail - * description: The update's thumbnail. - * variants: - * type: array - * description: The update's variants. - * items: - * type: object - * description: The variant's variants. - * required: - * - length - * - options - * - metadata - * - sku - * - barcode - * - hs_code - * - weight - * - height - * - width - * - origin_country - * - mid_code - * - material - * - ean - * - upc - * - variant_rank - * - id - * - title - * - prices - * - inventory_quantity - * - allow_backorder - * - manage_inventory - * properties: - * length: - * type: number - * title: length - * description: The variant's length. - * options: - * type: object - * description: The variant's options. - * properties: {} - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * sku: - * type: string - * title: sku - * description: The variant's sku. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * material: - * type: string - * title: material - * description: The variant's material. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * variant_rank: - * type: number - * title: variant_rank - * description: The variant's variant rank. - * id: - * type: string - * title: id - * description: The variant's ID. - * title: - * type: string - * title: title - * description: The variant's title. - * prices: - * type: array - * description: The variant's prices. - * items: - * type: object - * description: The price's prices. - * properties: {} - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * collection_id: - * type: string - * title: collection_id - * description: The update's collection id. - * tags: - * type: array - * description: The update's tags. - * items: - * type: object - * description: The tag's tags. - * required: - * - id - * - value - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * type_id: - * type: string - * title: type_id - * description: The update's type id. - * subtitle: - * type: string - * title: subtitle - * description: The update's subtitle. - * discountable: - * type: boolean - * title: discountable - * description: The update's discountable. - * images: - * type: array - * description: The update's images. - * items: - * type: object - * description: The image's images. - * required: - * - url - * properties: - * url: - * type: string - * title: url - * description: The image's url. - * categories: - * type: array - * description: The update's categories. - * items: - * type: object - * description: The category's categories. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The category's ID. - * sales_channels: - * type: array - * description: The update's sales channels. - * items: - * type: object - * description: The sales channel's sales channels. - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The sales channel's ID. - * id: - * type: string - * title: id - * description: The update's ID. - * delete: - * type: array - * description: The product's delete. - * items: - * type: string - * title: delete - * description: The delete's details. * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index 1808310686..bbead282af 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -57,12 +67,9 @@ * description: SUMMARY * required: * - code - * - is_automatic * - type * - campaign_id - * - campaign * - application_method - * - rules * properties: * code: * type: string @@ -88,11 +95,8 @@ * - name * - campaign_identifier * - description - * - currency - * - budget * - starts_at * - ends_at - * - promotions * properties: * name: * type: string @@ -106,16 +110,12 @@ * type: string * title: description * description: The campaign's description. - * currency: - * type: string - * title: currency - * description: The campaign's currency. * budget: * type: object * description: The campaign's budget. * required: * - type - * - limit + * - currency_code * properties: * type: * type: string @@ -126,6 +126,10 @@ * type: number * title: limit * description: The budget's limit. + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. * starts_at: * type: string * title: starts_at @@ -155,12 +159,10 @@ * required: * - description * - value + * - currency_code * - max_quantity * - type * - target_type - * - allocation - * - target_rules - * - buy_rules * - apply_to_quantity * - buy_rules_min_quantity * properties: @@ -172,6 +174,10 @@ * type: number * title: value * description: The application method's value. + * currency_code: + * type: string + * title: currency_code + * description: The application method's currency code. * max_quantity: * type: number * title: max_quantity @@ -223,12 +229,16 @@ * title: attribute * description: The target rule's attribute. * values: - * type: array - * description: The target rule's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The target rule's values. + * - type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. * buy_rules: * type: array * description: The application method's buy rules. @@ -260,12 +270,16 @@ * title: attribute * description: The buy rule's attribute. * values: - * type: array - * description: The buy rule's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The buy rule's values. + * - type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. * apply_to_quantity: * type: number * title: apply_to_quantity @@ -305,12 +319,16 @@ * title: attribute * description: The rule's attribute. * values: - * type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The rule's values. + * - type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL @@ -320,48 +338,27 @@ * -H 'Content-Type: application/json' \ * --data-raw '{ * "code": "{value}", - * "is_automatic": false, * "type": "{value}", * "campaign_id": "{value}", - * "campaign": { - * "name": "Helene", - * "campaign_identifier": "{value}", - * "description": "{value}", - * "currency": "MVR", - * "budget": { - * "type": "{value}", - * "limit": 7501249997963264 - * }, - * "starts_at": "2024-08-12T10:26:20.012Z", - * "ends_at": "2024-05-13T10:19:49.899Z", - * "promotions": [] - * }, * "application_method": { * "description": "{value}", - * "value": 8358287623847936, - * "max_quantity": 2469068038733824, + * "value": 1841223411171328, + * "currency_code": "{value}", + * "max_quantity": 2960098049654784, * "type": "{value}", * "target_type": "{value}", * "allocation": "{value}", * "target_rules": [], * "buy_rules": [], - * "apply_to_quantity": 5904452787634176, - * "buy_rules_min_quantity": 7660936294825984 - * }, - * "rules": [ - * { - * "operator": "{value}", - * "description": "{value}", - * "attribute": "{value}", - * "values": [ - * "{value}" - * ] - * } - * ] + * "apply_to_quantity": 708643867590656, + * "buy_rules_min_quantity": 3167972149428224 + * } * }' * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index faa13f70fc..0217d1b024 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -61,6 +71,8 @@ * schema: * type: object * description: SUMMARY + * required: + * - campaign_id * properties: * code: * type: string @@ -71,10 +83,10 @@ * title: is_automatic * description: The promotion's is automatic. * type: + * type: string * enum: * - standard * - buyget - * type: string * campaign_id: * type: string * title: campaign_id @@ -86,11 +98,8 @@ * - name * - campaign_identifier * - description - * - currency - * - budget * - starts_at * - ends_at - * - promotions * properties: * name: * type: string @@ -104,34 +113,36 @@ * type: string * title: description * description: The campaign's description. - * currency: - * type: string - * title: currency - * description: The campaign's currency. * budget: * type: object * description: The campaign's budget. + * required: + * - type + * - currency_code * properties: * type: + * type: string * enum: * - spend * - usage - * type: string * limit: * type: number * title: limit * description: The budget's limit. - * required: - * - type - * - limit + * currency_code: + * type: string + * title: currency_code + * description: The budget's currency code. * starts_at: * type: string * title: starts_at * description: The campaign's starts at. + * format: date-time * ends_at: * type: string * title: ends_at * description: The campaign's ends at. + * format: date-time * promotions: * type: array * description: The campaign's promotions. @@ -148,35 +159,45 @@ * application_method: * type: object * description: The promotion's application method. + * required: + * - description + * - max_quantity + * - currency_code + * - apply_to_quantity + * - buy_rules_min_quantity * properties: * description: * type: string * title: description * description: The application method's description. * value: - * type: string + * type: number * title: value * description: The application method's value. * max_quantity: * type: number * title: max_quantity * description: The application method's max quantity. + * currency_code: + * type: string + * title: currency_code + * description: The application method's currency code. * type: + * type: string * enum: * - fixed * - percentage - * type: string * target_type: + * type: string * enum: * - order * - shipping_methods * - items - * type: string * allocation: + * type: string * enum: * - each * - across - * type: string * target_rules: * type: array * description: The application method's target rules. @@ -190,6 +211,7 @@ * - values * properties: * operator: + * type: string * enum: * - gte * - lte @@ -198,7 +220,6 @@ * - eq * - ne * - in - * type: string * description: * type: string * title: description @@ -208,12 +229,16 @@ * title: attribute * description: The target rule's attribute. * values: - * type: array - * description: The target rule's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The target rule's values. + * - type: array + * description: The target rule's values. + * items: + * type: string + * title: values + * description: The value's values. * buy_rules: * type: array * description: The application method's buy rules. @@ -227,6 +252,7 @@ * - values * properties: * operator: + * type: string * enum: * - gte * - lte @@ -235,7 +261,6 @@ * - eq * - ne * - in - * type: string * description: * type: string * title: description @@ -245,12 +270,16 @@ * title: attribute * description: The buy rule's attribute. * values: - * type: array - * description: The buy rule's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The buy rule's values. + * - type: array + * description: The buy rule's values. + * items: + * type: string + * title: values + * description: The value's values. * apply_to_quantity: * type: number * title: apply_to_quantity @@ -259,17 +288,6 @@ * type: number * title: buy_rules_min_quantity * description: The application method's buy rules min quantity. - * required: - * - description - * - value - * - max_quantity - * - type - * - target_type - * - allocation - * - target_rules - * - buy_rules - * - apply_to_quantity - * - buy_rules_min_quantity * rules: * type: array * description: The promotion's rules. @@ -283,6 +301,7 @@ * - values * properties: * operator: + * type: string * enum: * - gte * - lte @@ -291,7 +310,6 @@ * - eq * - ne * - in - * type: string * description: * type: string * title: description @@ -301,29 +319,31 @@ * title: attribute * description: The rule's attribute. * values: - * type: array - * description: The rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * required: - * - code - * - is_automatic - * - type - * - campaign_id - * - campaign - * - application_method - * - rules + * oneOf: + * - type: string + * title: values + * description: The rule's values. + * - type: array + * description: The rule's values. + * items: + * type: string + * title: values + * description: The value's values. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/promotions/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "campaign_id": "{value}" + * }' * tags: * - Promotions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts index c176b9440e..2f9734cd30 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_buy-rules_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,37 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Promotions - * responses: - * "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" * requestBody: * content: * application/json: @@ -114,12 +103,16 @@ * title: attribute * description: The create's attribute. * values: - * type: array - * description: The create's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The create's values. + * - type: array + * description: The create's values. + * items: + * type: string + * title: values + * description: The value's values. * update: * type: array * description: The promotion's update. @@ -128,9 +121,7 @@ * description: The update's details. * required: * - id - * - operator * - description - * - attribute * - values * properties: * id: @@ -156,12 +147,16 @@ * title: attribute * description: The update's attribute. * values: - * type: array - * description: The update's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The update's values. + * - type: array + * description: The update's values. + * items: + * type: string + * title: values + * description: The value's values. * delete: * type: array * description: The promotion's delete. @@ -169,6 +164,29 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/buy-rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts index 21d83edef0..8956413210 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_rules_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,37 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Promotions - * responses: - * "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" * requestBody: * content: * application/json: @@ -114,12 +103,16 @@ * title: attribute * description: The create's attribute. * values: - * type: array - * description: The create's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The create's values. + * - type: array + * description: The create's values. + * items: + * type: string + * title: values + * description: The value's values. * update: * type: array * description: The promotion's update. @@ -128,9 +121,7 @@ * description: The update's details. * required: * - id - * - operator * - description - * - attribute * - values * properties: * id: @@ -156,12 +147,16 @@ * title: attribute * description: The update's attribute. * values: - * type: array - * description: The update's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The update's values. + * - type: array + * description: The update's values. + * items: + * type: string + * title: values + * description: The value's values. * delete: * type: array * description: The promotion's delete. @@ -169,6 +164,29 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts index fb23ab21ae..c661107249 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id]_target-rules_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,37 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Promotions - * responses: - * "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" * requestBody: * content: * application/json: @@ -114,12 +103,16 @@ * title: attribute * description: The create's attribute. * values: - * type: array - * description: The create's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The create's values. + * - type: array + * description: The create's values. + * items: + * type: string + * title: values + * description: The value's values. * update: * type: array * description: The promotion's update. @@ -128,9 +121,7 @@ * description: The update's details. * required: * - id - * - operator * - description - * - attribute * - values * properties: * id: @@ -156,12 +147,16 @@ * title: attribute * description: The update's attribute. * values: - * type: array - * description: The update's values. - * items: - * type: string - * title: values - * description: The value's values. + * oneOf: + * - type: string + * title: values + * description: The update's values. + * - type: array + * description: The update's values. + * items: + * type: string + * title: values + * description: The value's values. * delete: * type: array * description: The promotion's delete. @@ -169,6 +164,29 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/promotions/{id}/target-rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Promotions + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts index 314dfd4b31..7c02d29667 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -58,9 +68,6 @@ * required: * - name * - currency_code - * - countries - * - automatic_taxes - * - payment_providers * - metadata * properties: * name: @@ -92,7 +99,6 @@ * metadata: * type: object * description: The region's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -101,20 +107,15 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Charlie", + * "name": "Heloise", * "currency_code": "{value}", - * "countries": [ - * "{value}" - * ], - * "automatic_taxes": true, - * "payment_providers": [ - * "{value}" - * ], * "metadata": {} * }' * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts index 792b1761d6..1790344d19 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -62,11 +72,6 @@ * type: object * description: SUMMARY * required: - * - name - * - currency_code - * - countries - * - automatic_taxes - * - payment_providers * - metadata * properties: * name: @@ -98,7 +103,6 @@ * metadata: * type: object * description: The region's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -107,20 +111,13 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Alden", - * "currency_code": "{value}", - * "countries": [ - * "{value}" - * ], - * "automatic_taxes": false, - * "payment_providers": [ - * "{value}" - * ], * "metadata": {} * }' * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts index 0a3133986e..968a4b5c18 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -86,7 +96,6 @@ * metadata: * type: object * description: The reservation's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -98,13 +107,15 @@ * "line_item_id": "{value}", * "location_id": "{value}", * "inventory_item_id": "{value}", - * "quantity": 3939752942239744, + * "quantity": 3268935814217728, * "description": "{value}", * "metadata": {} * }' * tags: * - Reservations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts index 2f4d620005..d618559935 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -62,8 +72,6 @@ * type: object * description: SUMMARY * required: - * - location_id - * - quantity * - description * - metadata * properties: @@ -82,7 +90,6 @@ * metadata: * type: object * description: The reservation's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -91,14 +98,14 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "location_id": "{value}", - * "quantity": 5781024600489984, * "description": "{value}", * "metadata": {} * }' * tags: * - Reservations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types.ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts similarity index 58% rename from www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types.ts rename to www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts index 6de8a2208c..36a4f5b267 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_pricing_rule-types.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons.ts @@ -1,8 +1,8 @@ /** - * @oas [post] /admin/pricing/rule-types - * operationId: PostPricingRuleTypes - * summary: Create Pricing - * description: Create a pricing. + * @oas [post] /admin/return-reasons + * operationId: PostReturnReasons + * summary: Create Return Reason + * description: Create a return reason. * x-authenticated: true * parameters: * - name: expand @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,40 +63,23 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - rule_attribute - * - default_priority - * properties: - * name: - * type: string - * title: name - * description: The pricing's name. - * rule_attribute: - * type: string - * title: rule_attribute - * description: The pricing's rule attribute. - * default_priority: - * type: number - * title: default_priority - * description: The pricing's default priority. + * $ref: "#/components/schemas/CreateOrderReturnReason" * x-codeSamples: * - lang: Shell * label: cURL * source: |- - * curl -X POST '{backend_url}/admin/pricing/rule-types' \ + * curl -X POST '{backend_url}/admin/return-reasons' \ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Thurman", - * "rule_attribute": "{value}", - * "default_priority": 4640267816665088 + * "value": "{value}", + * "label": "{value}" * }' * tags: - * - Pricing + * - Return Reasons * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts new file mode 100644 index 0000000000..a378e5fac0 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_return-reasons_[id].ts @@ -0,0 +1,98 @@ +/** + * @oas [post] /admin/return-reasons/{id} + * operationId: PostReturnReasonsId + * summary: Update a Return Reason + * description: Update a return reason's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return reason's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/UpdateOrderReturnReason" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/return-reasons/{id}' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Return Reasons + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts new file mode 100644 index 0000000000..94b1e7135c --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -0,0 +1,110 @@ +/** + * @oas [post] /admin/returns + * operationId: PostReturns + * summary: Create Return + * description: Create a return. + * x-authenticated: true + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReturnsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}", + * "items": [ + * { + * "id": "id_7DO5H2LbSN3p7IzB", + * "quantity": 1357590174892032, + * "reason_id": "{value}", + * "note": "{value}" + * } + * ], + * "return_shipping": { + * "option_id": "{value}", + * "price": 5112171463704576 + * }, + * "internal_note": "{value}", + * "location_id": "{value}" + * }' + * tags: + * - Returns + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts new file mode 100644 index 0000000000..8122be1c47 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_cancel.ts @@ -0,0 +1,93 @@ +/** + * @oas [post] /admin/returns/{id}/cancel + * operationId: PostReturnsIdCancel + * summary: Add Cancels to Return + * description: Add a list of cancels to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/cancel' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Returns + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts new file mode 100644 index 0000000000..420d0df179 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -0,0 +1,111 @@ +/** + * @oas [post] /admin/returns/{id}/receive + * operationId: PostReturnsIdReceive + * summary: Add Receives to Return + * description: Add a list of receives to a return. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The return's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminPostReceiveReturnsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/returns/{id}/receive' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "return_id": "{value}", + * "items": [ + * { + * "id": "id_qfy3t6cU7m8O5cJ5zs", + * "quantity": 6429460591017984, + * "reason_id": "{value}", + * "note": "{value}" + * } + * ], + * "internal_note": "{value}" + * }' + * tags: + * - Returns + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts index 2858fe9a54..89cc49c898 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,25 +45,42 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminCreateSalesChannel" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/sales-channels' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Linnea", + * "description": "{value}", + * "metadata": {} + * }' * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,33 +93,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - name - * - description - * - is_disabled - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The sales channel's name. - * description: - * type: string - * title: description - * description: The sales channel's description. - * is_disabled: - * type: boolean - * title: is_disabled - * description: The sales channel's is disabled. - * metadata: - * type: object - * description: The sales channel's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts index 85a4a94d67..ce0b6b1968 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,41 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateSalesChannel" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/sales-channels/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "description": "{value}", + * "metadata": {} + * }' * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,33 +98,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - name - * - description - * - is_disabled - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The sales channel's name. - * description: - * type: string - * title: description - * description: The sales channel's description. - * is_disabled: - * type: boolean - * title: is_disabled - * description: The sales channel's is disabled. - * metadata: - * type: object - * description: The sales channel's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index baa355b29e..014ced4834 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Sales Channels * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts index f5d543922a..ca904ae435 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,12 +69,10 @@ * - name * - service_zone_id * - shipping_profile_id - * - data * - price_type * - provider_id * - type * - prices - * - rules * properties: * name: * type: string @@ -81,9 +89,11 @@ * data: * type: object * description: The shipping option's data. - * properties: {} * price_type: * type: string + * enum: + * - calculated + * - flat * provider_id: * type: string * title: provider_id @@ -154,6 +164,15 @@ * properties: * operator: * type: string + * enum: + * - in + * - eq + * - ne + * - gt + * - gte + * - lt + * - lte + * - nin * attribute: * type: string * title: attribute @@ -177,22 +196,17 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Caitlyn", + * "name": "Julie", * "service_zone_id": "{value}", * "shipping_profile_id": "{value}", - * "data": {}, + * "price_type": "{value}", * "provider_id": "{value}", * "type": { * "label": "{value}", * "description": "{value}", * "code": "{value}" * }, - * "prices": [], - * "rules": [ - * { - * "attribute": "{value}" - * } - * ] + * "prices": [] * }' * tags: * - Shipping Options @@ -202,7 +216,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminShippingOptionRetrieveResponse" + * $ref: "#/components/schemas/AdminShippingOptionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts index 58da26ac21..5a90336e1f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -61,15 +71,6 @@ * schema: * type: object * description: SUMMARY - * required: - * - name - * - data - * - price_type - * - provider_id - * - shipping_profile_id - * - type - * - prices - * - rules * properties: * name: * type: string @@ -78,13 +79,19 @@ * data: * type: object * description: The shipping option's data. - * properties: {} * price_type: * type: string + * enum: + * - calculated + * - flat * provider_id: * type: string * title: provider_id * description: The shipping option's provider id. + * shipping_profile_id: + * type: string + * title: shipping_profile_id + * description: The shipping option's shipping profile id. * type: * type: object * description: The shipping option's type. @@ -112,10 +119,6 @@ * oneOf: * - type: object * description: The price's prices. - * required: - * - id - * - currency_code - * - amount * properties: * id: * type: string @@ -131,10 +134,6 @@ * description: The price's amount. * - type: object * description: The price's prices. - * required: - * - id - * - region_id - * - amount * properties: * id: * type: string @@ -160,7 +159,17 @@ * - attribute * - value * properties: - * operator: {} + * operator: + * type: string + * enum: + * - in + * - eq + * - ne + * - gt + * - gte + * - lt + * - lte + * - nin * attribute: * type: string * title: attribute @@ -188,7 +197,17 @@ * type: string * title: id * description: The rule's ID. - * operator: {} + * operator: + * type: string + * enum: + * - in + * - eq + * - ne + * - gt + * - gte + * - lt + * - lte + * - nin * attribute: * type: string * title: attribute @@ -204,29 +223,12 @@ * type: string * title: value * description: The value's details. - * shipping_profile_id: - * type: string - * title: shipping_profile_id - * description: The shipping option's shipping profile id. * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/shipping-options/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "name": "Delta", - * "data": {}, - * "provider_id": "{value}", - * "type": { - * "label": "{value}", - * "description": "{value}", - * "code": "{value}" - * }, - * "prices": [], - * "rules": [] - * }' + * -H 'x-medusa-access-token: {api_token}' * tags: * - Shipping Options * responses: @@ -235,7 +237,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminShippingOptionRetrieveResponse" + * $ref: "#/components/schemas/AdminShippingOptionResponse" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts index 2b0b3e3165..7096357403 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id]_rules_batch.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,37 +51,20 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ - * -H 'x-medusa-access-token: {api_token}' - * tags: - * - Shipping Options - * responses: - * "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" * requestBody: * content: * application/json: @@ -169,6 +158,29 @@ * type: string * title: delete * description: The delete's details. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-options/{id}/rules/batch' \ + * -H 'x-medusa-access-token: {api_token}' + * tags: + * - Shipping Options + * 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" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index cbe70691fe..c7d2332ea3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -71,7 +81,6 @@ * metadata: * type: object * description: The shipping profile's metadata. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -80,7 +89,7 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Ford", + * "name": "Percy", * "type": "{value}", * "metadata": {} * }' diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts new file mode 100644 index 0000000000..cbe813be6e --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts @@ -0,0 +1,121 @@ +/** + * @oas [post] /admin/shipping-profiles/{id} + * operationId: PostShippingProfilesId + * summary: Update a Shipping Profile + * description: Update a shipping profile's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping profile's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The shipping profile's name. + * type: + * type: string + * title: type + * description: The shipping profile's type. + * metadata: + * type: object + * description: The shipping profile's metadata. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/shipping-profiles/{id}' \ + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "metadata": {} + * }' + * tags: + * - Shipping Profiles + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminShippingProfileResponse" + * "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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts index e3a9787937..104869add5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,71 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - address - * - address_id - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The stock location's name. - * address: - * type: object - * description: The stock location's address. - * required: - * - address_1 - * - address_2 - * - company - * - city - * - country_code - * - phone - * - postal_code - * - province - * properties: - * address_1: - * type: string - * title: address_1 - * description: The address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The address's address 2. - * company: - * type: string - * title: company - * description: The address's company. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * phone: - * type: string - * title: phone - * description: The address's phone. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * province: - * type: string - * title: province - * description: The address's province. - * address_id: - * type: string - * title: address_id - * description: The stock location's address id. - * metadata: - * type: object - * description: The stock location's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateStockLocation" * x-codeSamples: * - lang: Shell * label: cURL @@ -126,11 +72,15 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Dorthy" + * "name": "Maryam", + * "address_id": "{value}", + * "metadata": {} * }' * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts index d8cb7827b7..fd123773eb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,71 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - name - * - address - * - address_id - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The stock location's name. - * address: - * type: object - * description: The stock location's address. - * required: - * - address_1 - * - address_2 - * - company - * - city - * - country_code - * - phone - * - postal_code - * - province - * properties: - * address_1: - * type: string - * title: address_1 - * description: The address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The address's address 2. - * company: - * type: string - * title: company - * description: The address's company. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * phone: - * type: string - * title: phone - * description: The address's phone. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * province: - * type: string - * title: province - * description: The address's province. - * address_id: - * type: string - * title: address_id - * description: The stock location's address id. - * metadata: - * type: object - * description: The stock location's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminUpdateStockLocation" * x-codeSamples: * - lang: Shell * label: cURL @@ -132,23 +78,14 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Gustave", - * "address": { - * "address_1": "{value}", - * "address_2": "{value}", - * "company": "{value}", - * "city": "{value}", - * "country_code": "{value}", - * "phone": "{value}", - * "postal_code": "{value}", - * "province": "{value}" - * }, * "address_id": "{value}", * "metadata": {} * }' * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts index 0f4f1ca043..6503d96544 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-sets.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -81,12 +91,14 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Jeremie", + * "name": "Helene", * "type": "{value}" * }' * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index 2af0dc35e7..e47f7b5c7c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -85,6 +95,8 @@ * tags: * - Stock Locations * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts index 0196677848..34ed88e194 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,44 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateStore" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/stores/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "name": "Melvina", + * "default_sales_channel_id": "{value}", + * "default_region_id": "{value}", + * "default_location_id": "{value}", + * "metadata": {} + * }' * tags: * - Stores * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,51 +101,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - name - * - supported_currency_codes - * - default_currency_code - * - default_sales_channel_id - * - default_region_id - * - default_location_id - * - metadata - * properties: - * name: - * type: string - * title: name - * description: The store's name. - * supported_currency_codes: - * type: array - * description: The store's supported currency codes. - * items: - * type: string - * title: supported_currency_codes - * description: The supported currency code's supported currency codes. - * default_currency_code: - * type: string - * title: default_currency_code - * description: The store's default currency code. - * default_sales_channel_id: - * type: string - * title: default_sales_channel_id - * description: The store's default sales channel id. - * default_region_id: - * type: string - * title: default_region_id - * description: The store's default region id. - * default_location_id: - * type: string - * title: default_location_id - * description: The store's default location id. - * metadata: - * type: object - * description: The store's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts index bd91057080..b39974c552 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,64 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - rate - * - code - * - rules - * - name - * - is_default - * - is_combinable - * - tax_region_id - * - metadata - * properties: - * rate: - * type: number - * title: rate - * description: The tax rate's rate. - * code: - * type: string - * title: code - * description: The tax rate's code. - * rules: - * type: array - * description: The tax rate's rules. - * items: - * type: object - * description: The rule's rules. - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The rule's reference. - * reference_id: - * type: string - * title: reference_id - * description: The rule's reference id. - * name: - * type: string - * title: name - * description: The tax rate's name. - * is_default: - * type: boolean - * title: is_default - * description: The tax rate's is default. - * is_combinable: - * type: boolean - * title: is_combinable - * description: The tax rate's is combinable. - * tax_region_id: - * type: string - * title: tax_region_id - * description: The tax rate's tax region id. - * metadata: - * type: object - * description: The tax rate's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateTaxRate" * x-codeSamples: * - lang: Shell * label: cURL @@ -119,12 +72,15 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "name": "Myrl", - * "tax_region_id": "{value}" + * "name": "Kaylin", + * "tax_region_id": "{value}", + * "metadata": {} * }' * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts index a20741e999..89422004ec 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,68 +69,22 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * properties: - * code: - * type: string - * title: code - * description: The tax rate's code. - * name: - * type: string - * title: name - * description: The tax rate's name. - * rate: - * type: number - * title: rate - * description: The tax rate's rate. - * rules: - * type: array - * description: The tax rate's rules. - * items: - * type: object - * description: The rule's rules. - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The rule's reference. - * reference_id: - * type: string - * title: reference_id - * description: The rule's reference id. - * is_default: - * type: boolean - * title: is_default - * description: The tax rate's is default. - * is_combinable: - * type: boolean - * title: is_combinable - * description: The tax rate's is combinable. - * metadata: - * type: object - * description: The tax rate's metadata. - * properties: {} - * required: - * - rate - * - code - * - rules - * - name - * - is_default - * - is_combinable - * - metadata + * $ref: "#/components/schemas/AdminUpdateTaxRate" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/tax-rates/{id}' \ - * -H 'x-medusa-access-token: {api_token}' + * -H 'x-medusa-access-token: {api_token}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "metadata": {} + * }' * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index f68ff2ffe7..dd62a25b58 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,20 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - reference - * - reference_id - * properties: - * reference: - * type: string - * title: reference - * description: The tax rate's reference. - * reference_id: - * type: string - * title: reference_id - * description: The tax rate's reference id. + * $ref: "#/components/schemas/AdminCreateTaxRateRule" * x-codeSamples: * - lang: Shell * label: cURL @@ -87,6 +84,8 @@ * tags: * - Tax Rates * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts index 0212472154..940bc8d6dc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -53,62 +63,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - country_code - * - province_code - * - parent_id - * - default_tax_rate - * - metadata - * properties: - * country_code: - * type: string - * title: country_code - * description: The tax region's country code. - * province_code: - * type: string - * title: province_code - * description: The tax region's province code. - * parent_id: - * type: string - * title: parent_id - * description: The tax region's parent id. - * default_tax_rate: - * type: object - * description: The tax region's default tax rate. - * required: - * - rate - * - code - * - name - * - is_combinable - * - metadata - * properties: - * rate: - * type: number - * title: rate - * description: The default tax rate's rate. - * code: - * type: string - * title: code - * description: The default tax rate's code. - * name: - * type: string - * title: name - * description: The default tax rate's name. - * metadata: - * type: object - * description: The default tax rate's metadata. - * properties: {} - * is_combinable: - * type: string - * enum: - * - "true" - * - "false" - * metadata: - * type: object - * description: The tax region's metadata. - * properties: {} + * $ref: "#/components/schemas/AdminCreateTaxRegion" * x-codeSamples: * - lang: Shell * label: cURL @@ -117,11 +72,16 @@ * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "country_code": "{value}" + * "country_code": "{value}", + * "province_code": "{value}", + * "parent_id": "{value}", + * "metadata": {} * }' * tags: * - Tax Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts index 6e2a570c9f..2b7ebb3797 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,16 +45,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] * - jwt_token: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminGetUploadParams" * x-codeSamples: * - lang: Shell * label: cURL @@ -58,6 +73,8 @@ * tags: * - Uploads * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,11 +87,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/CreateProduct" * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts b/www/utils/generated/oas-output/operations/admin/post_admin_users.ts index d0481c870f..aeffca9344 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users.ts @@ -3,7 +3,7 @@ * operationId: PostUsers * summary: Create User * description: Create a user. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: expand * in: query @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,16 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * requestBody: * content: * application/json: @@ -59,14 +65,15 @@ * label: cURL * source: |- * curl -X POST '{backend_url}/admin/users' \ - * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "email": "Moises11@hotmail.com" + * "email": "Janie42@hotmail.com" * }' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index 6089ef3760..9ba095c510 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -3,7 +3,7 @@ * operationId: PostUsersId * summary: Update a User * description: Update a user's details. - * x-authenticated: true + * x-authenticated: false * parameters: * - name: id * in: path @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,52 +51,37 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * security: - * - api_token: [] - * - cookie_auth: [] - * - jwt_token: [] + * 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 + * `-`. * requestBody: * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - first_name - * - last_name - * - avatar_url - * properties: - * first_name: - * type: string - * title: first_name - * description: The user's first name. - * last_name: - * type: string - * title: last_name - * description: The user's last name. - * avatar_url: - * type: string - * title: avatar_url - * description: The user's avatar url. + * $ref: "#/components/schemas/AdminUpdateUser" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/admin/users/{id}' \ - * -H 'x-medusa-access-token: {api_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ + * "first_name": "{value}", + * "last_name": "{value}", * "avatar_url": "{value}" * }' * tags: * - Users * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts index 5f1f7cf3bb..d2a75058cf 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_run.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,17 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * properties: - * input: {} - * transaction_id: - * type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * required: - * - input - * - transaction_id + * $ref: "#/components/schemas/AdminCreateWorkflowsRun" * x-codeSamples: * - lang: Shell * label: cURL @@ -81,6 +81,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts index 1b9aede8da..0a1cdc5d76 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_failure.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,30 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - transaction_id - * - step_id - * - response - * - compensate_input - * - action - * properties: - * transaction_id: - * type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * step_id: - * type: string - * title: step_id - * description: The workflows execution's step id. - * response: {} - * compensate_input: {} - * action: - * enum: - * - invoke - * - compensate - * type: string + * $ref: "#/components/schemas/AdminCreateWorkflowsAsyncResponse" * x-codeSamples: * - lang: Shell * label: cURL @@ -101,6 +88,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts index 2978797cd3..665f969cf6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_workflows-executions_[workflow_id]_steps_success.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -59,30 +69,7 @@ * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - transaction_id - * - step_id - * - response - * - compensate_input - * - action - * properties: - * transaction_id: - * type: string - * title: transaction_id - * description: The workflows execution's transaction id. - * step_id: - * type: string - * title: step_id - * description: The workflows execution's step id. - * response: {} - * compensate_input: {} - * action: - * enum: - * - invoke - * - compensate - * type: string + * $ref: "#/components/schemas/AdminCreateWorkflowsAsyncResponse" * x-codeSamples: * - lang: Shell * label: cURL @@ -101,6 +88,8 @@ * tags: * - Workflows Executions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts similarity index 56% rename from www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts rename to www/utils/generated/oas-output/operations/auth/delete_auth_session.ts index 3aea6798cb..bbee004c31 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider]_callback.ts +++ b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts @@ -1,23 +1,10 @@ /** - * @oas [get] /auth/{scope}/{auth_provider}/callback - * operationId: GetScopeAuth_providerCallback - * summary: List Callbacks - * description: Retrieve a list of callbacks in a [scope]. The callbacks can be - * filtered by fields like FILTER FIELDS. The callbacks can also be paginated. + * @oas [delete] /auth/session + * operationId: DeleteSession + * summary: Delete Session + * description: Delete Session * x-authenticated: false * parameters: - * - name: scope - * in: path - * description: The [scope]'s scope. - * required: true - * schema: - * type: string - * - name: auth_provider - * in: path - * description: The [scope]'s auth provider. - * required: true - * schema: - * type: string * - name: expand * in: query * description: Comma-separated relations that should be expanded in the returned data. @@ -28,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,19 +45,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/auth/{scope}/{auth_provider}/callback' + * source: curl -X DELETE '{backend_url}/auth/session' * tags: - * - "[scope]" + * - Session * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +76,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts similarity index 54% rename from www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts rename to www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts index febd82b8d9..dcf1d347aa 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[auth_provider].ts +++ b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider].ts @@ -1,20 +1,20 @@ /** - * @oas [get] /auth/{scope}/{auth_provider} - * operationId: GetScopeAuth_provider + * @oas [get] /auth/{actor_type}/{auth_provider} + * operationId: GetActor_typeAuth_provider * summary: "List " - * description: Retrieve a list of in a [scope]. The can be filtered by fields - * like FILTER FIELDS. The can also be paginated. + * description: Retrieve a list of in a [actor_type]. The can be filtered by + * fields like FILTER FIELDS. The can also be paginated. * x-authenticated: false * parameters: - * - name: scope + * - name: actor_type * in: path - * description: The [scope]'s scope. + * description: The [actor type]'s actor type. * required: true * schema: * type: string * - name: auth_provider * in: path - * description: The [scope]'s auth provider. + * description: The [actor type]'s auth provider. * required: true * schema: * type: string @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,19 +58,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/auth/{scope}/{auth_provider}' + * source: curl '{backend_url}/auth/{actor_type}/{auth_provider}' * tags: - * - "[scope]" + * - "[actor_type]" * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +89,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts new file mode 100644 index 0000000000..1bb6543916 --- /dev/null +++ b/www/utils/generated/oas-output/operations/auth/get_auth_[actor_type]_[auth_provider]_callback.ts @@ -0,0 +1,94 @@ +/** + * @oas [get] /auth/{actor_type}/{auth_provider}/callback + * operationId: GetActor_typeAuth_providerCallback + * summary: List Callbacks + * description: Retrieve a list of callbacks in a [actor_type]. The callbacks can + * be filtered by fields like FILTER FIELDS. The callbacks can also be paginated. + * x-authenticated: false + * parameters: + * - name: actor_type + * in: path + * description: The [actor type]'s actor type. + * required: true + * schema: + * type: string + * - name: auth_provider + * in: path + * description: The [actor type]'s auth provider. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/auth/{actor_type}/{auth_provider}/callback' + * tags: + * - "[actor_type]" + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts similarity index 55% rename from www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts rename to www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts index ccf984e11d..93063f3b06 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider].ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts @@ -1,19 +1,19 @@ /** - * @oas [post] /auth/{scope}/{auth_provider} - * operationId: PostScopeAuth_provider - * summary: Add to [scope] - * description: Add a list of to a [scope]. + * @oas [post] /auth/{actor_type}/{auth_provider} + * operationId: PostActor_typeAuth_provider + * summary: Add to [actor_type] + * description: Add a list of to a [actor_type]. * x-authenticated: false * parameters: - * - name: scope + * - name: actor_type * in: path - * description: The [scope]'s scope. + * description: The [actor type]'s actor type. * required: true * schema: * type: string * - name: auth_provider * in: path - * description: The [scope]'s auth provider. + * description: The [actor type]'s auth provider. * required: true * schema: * type: string @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,19 +57,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}' + * source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}' * tags: - * - "[scope]" + * - "[actor_type]" * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts similarity index 54% rename from www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts rename to www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts index a776ba17ea..d60e9baa1e 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[auth_provider]_callback.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts @@ -1,19 +1,19 @@ /** - * @oas [post] /auth/{scope}/{auth_provider}/callback - * operationId: PostScopeAuth_providerCallback - * summary: Add Callbacks to [scope] - * description: Add a list of callbacks to a [scope]. + * @oas [post] /auth/{actor_type}/{auth_provider}/callback + * operationId: PostActor_typeAuth_providerCallback + * summary: Add Callbacks to [actor_type] + * description: Add a list of callbacks to a [actor_type]. * x-authenticated: false * parameters: - * - name: scope + * - name: actor_type * in: path - * description: The [scope]'s scope. + * description: The [actor type]'s actor type. * required: true * schema: * type: string * - name: auth_provider * in: path - * description: The [scope]'s auth provider. + * description: The [actor type]'s auth provider. * required: true * schema: * type: string @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,19 +57,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/auth/{scope}/{auth_provider}/callback' + * source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/callback' * tags: - * - "[scope]" + * - "[actor_type]" * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts b/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts deleted file mode 100644 index 940c4c5254..0000000000 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider].ts +++ /dev/null @@ -1,85 +0,0 @@ -/** - * @oas [post] /auth/{scope}/{authProvider} - * operationId: PostScopeAuthprovider - * summary: Add to [scope] - * description: Add a list of to a [scope]. - * x-authenticated: false - * parameters: - * - name: scope - * in: path - * description: The [scope]'s scope. - * required: true - * schema: - * type: string - * - name: authProvider - * in: path - * description: The [scope]'s authprovider. - * required: true - * schema: - * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}' - * tags: - * - "[scope]" - * responses: - * "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" - * requestBody: - * content: - * application/json: - * schema: {} - * -*/ - diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts deleted file mode 100644 index 07f8e2574c..0000000000 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[scope]_[authProvider]_callback.ts +++ /dev/null @@ -1,85 +0,0 @@ -/** - * @oas [post] /auth/{scope}/{authProvider}/callback - * operationId: PostScopeAuthproviderCallback - * summary: Add Callbacks to [scope] - * description: Add a list of callbacks to a [scope]. - * x-authenticated: false - * parameters: - * - name: scope - * in: path - * description: The [scope]'s scope. - * required: true - * schema: - * type: string - * - name: authProvider - * in: path - * description: The [scope]'s authprovider. - * required: true - * schema: - * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: curl -X POST '{backend_url}/auth/{scope}/{authProvider}/callback' - * tags: - * - "[scope]" - * responses: - * "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" - * requestBody: - * content: - * application/json: - * schema: {} - * -*/ - diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts index 0aa63c7216..96062d79cb 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -52,6 +62,8 @@ * tags: * - Session * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -64,10 +76,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts index c390447490..c89cde1e2e 100644 --- a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts +++ b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -58,6 +68,8 @@ * tags: * - Payment * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,10 +82,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 9e4c384bed..a8d85c8581 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -28,12 +28,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,12 +58,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -65,6 +75,33 @@ * tags: * - Carts * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The cart's ID. + * object: + * type: string + * title: object + * description: The cart's object. + * deleted: + * type: boolean + * title: deleted + * description: The cart's deleted. + * parent: + * type: object + * description: The cart's parent. * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +114,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index 9d405a71bb..f55f921c65 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +69,8 @@ * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,21 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - promo_codes - * properties: - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts index 03fefd2b32..7997e5f6b5 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_customers_me_addresses_[address_id].ts @@ -4,7 +4,7 @@ * summary: Remove Addresses from Customer * description: Remove a list of addresses from a customer. This doesn't delete the * Address, only the association between the Address and the customer. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: address_id * in: path @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,19 +52,30 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' + * source: |- + * curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \ + * -H 'Authorization: Bearer {access_token}' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts index 13e0239f36..16b178a3fe 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +69,8 @@ * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index f5ec6368bd..d1201868e1 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -53,6 +63,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,10 +77,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts index dd2b371d80..3128ef0538 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +69,8 @@ * tags: * - Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index 7513ba0edc..908a136584 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -53,6 +63,8 @@ * tags: * - Currencies * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,10 +77,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts index 70179a2250..48ce0ed21c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +69,8 @@ * tags: * - Currencies * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index 35e3e4f3f1..fe674d0907 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -4,7 +4,7 @@ * summary: List Customers * description: Retrieve a list of customers. The customers can be filtered by * fields such as `id`. The customers can also be sorted or paginated. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: expand * in: query @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,19 +46,30 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/store/customers/me' + * source: |- + * curl '{backend_url}/store/customers/me' \ + * -H 'Authorization: Bearer {access_token}' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,18 +82,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The customer's fields. * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index e377ee5b81..478324ff23 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -4,7 +4,7 @@ * summary: List Customers * description: Retrieve a list of customers. The customers can be filtered by * fields such as `id`. The customers can also be sorted or paginated. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: expand * in: query @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,19 +46,141 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: metadata + * in: query + * description: The customer's metadata. + * required: true + * schema: + * type: object + * description: The customer's metadata. + * - name: first_name + * in: query + * description: The customer's first name. + * required: true + * schema: + * type: string + * title: first_name + * description: The customer's first name. + * - name: last_name + * in: query + * description: The customer's last name. + * required: true + * schema: + * type: string + * title: last_name + * description: The customer's last name. + * - name: phone + * in: query + * description: The customer's phone. + * required: true + * schema: + * type: string + * title: phone + * description: The customer's phone. + * - name: company + * in: query + * description: The customer's company. + * required: true + * schema: + * type: string + * title: company + * description: The customer's company. + * - name: address_1 + * in: query + * description: The customer's address 1. + * required: true + * schema: + * type: string + * title: address_1 + * description: The customer's address 1. + * - name: address_2 + * in: query + * description: The customer's address 2. + * required: true + * schema: + * type: string + * title: address_2 + * description: The customer's address 2. + * - name: city + * in: query + * description: The customer's city. + * required: true + * schema: + * type: string + * title: city + * description: The customer's city. + * - name: country_code + * in: query + * description: The customer's country code. + * required: true + * schema: + * type: string + * title: country_code + * description: The customer's country code. + * - name: province + * in: query + * description: The customer's province. + * required: true + * schema: + * type: string + * title: province + * description: The customer's province. + * - name: postal_code + * in: query + * description: The customer's postal code. + * required: true + * schema: + * type: string + * title: postal_code + * description: The customer's postal code. + * - name: address_name + * in: query + * description: The customer's address name. + * required: true + * schema: + * type: string + * title: address_name + * description: The customer's address name. + * - name: is_default_shipping + * in: query + * description: The customer's is default shipping. + * required: false + * schema: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * - name: is_default_billing + * in: query + * description: The customer's is default billing. + * required: false + * schema: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * security: + * - cookie_auth: [] + * - jwt_token: [] * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/store/customers/me/addresses' + * source: |- + * curl '{backend_url}/store/customers/me/addresses' \ + * -H 'Authorization: Bearer {access_token}' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,83 +193,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - metadata - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - address_name - * - is_default_shipping - * - is_default_billing - * properties: - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. - * company: - * type: string - * title: company - * description: The customer's company. - * address_1: - * type: string - * title: address_1 - * description: The customer's address 1. - * address_2: - * type: string - * title: address_2 - * description: The customer's address 2. - * city: - * type: string - * title: city - * description: The customer's city. - * country_code: - * type: string - * title: country_code - * description: The customer's country code. - * province: - * type: string - * title: province - * description: The customer's province. - * postal_code: - * type: string - * title: postal_code - * description: The customer's postal code. - * address_name: - * type: string - * title: address_name - * description: The customer's address name. - * is_default_shipping: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * is_default_billing: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index ef03434d94..d4b768f5cc 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -4,7 +4,7 @@ * summary: List Addresses * description: Retrieve a list of addresses in a customer. The addresses can be * filtered by fields like FILTER FIELDS. The addresses can also be paginated. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: address_id * in: path @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,19 +52,30 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/store/customers/me/addresses/{address_id}' + * source: |- + * curl '{backend_url}/store/customers/me/addresses/{address_id}' \ + * -H 'Authorization: Bearer {access_token}' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,18 +88,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - fields - * properties: - * fields: - * type: string - * title: fields - * description: The customer's fields. * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts new file mode 100644 index 0000000000..765766f2c3 --- /dev/null +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -0,0 +1,118 @@ +/** + * @oas [get] /store/orders + * operationId: GetOrders + * summary: List Orders + * description: Retrieve a list of orders. The orders can be filtered by fields + * such as `id`. The orders can also be sorted or paginated. + * x-authenticated: false + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * - 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: name + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: name + * description: The order's name. + * - type: array + * description: The order's name. + * items: + * type: string + * title: name + * description: The name's details. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/orders' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts new file mode 100644 index 0000000000..83957125e1 --- /dev/null +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -0,0 +1,124 @@ +/** + * @oas [get] /store/orders/{id} + * operationId: GetOrdersId + * summary: Get a Order + * description: Retrieve a order by its ID. You can expand the order's relations or + * select the fields that should be returned. + * x-authenticated: false + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * - 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: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/orders/{id}' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts new file mode 100644 index 0000000000..26dc203209 --- /dev/null +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -0,0 +1,121 @@ +/** + * @oas [get] /store/payment-providers + * operationId: GetPaymentProviders + * summary: List Payment Providers + * description: Retrieve a list of payment providers. The payment providers can be + * filtered by fields such as `id`. The payment providers can also be sorted or + * paginated. + * x-authenticated: false + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * - name: region_id + * in: query + * description: The payment provider's region id. + * required: true + * schema: + * type: string + * title: region_id + * description: The payment provider's region id. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The payment provider's ID. + * - type: array + * description: The payment provider's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: is_enabled + * in: query + * description: The payment provider's is enabled. + * required: false + * schema: + * type: boolean + * title: is_enabled + * description: The payment provider's is enabled. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl '{backend_url}/store/payment-providers' + * tags: + * - Payment Providers + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index afd5a8f0da..5b72639746 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -17,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -41,12 +47,203 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: The product category's q. + * required: false + * schema: + * type: string + * title: q + * description: The product category's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product category's ID. + * - type: array + * description: The product category's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: description + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: description + * description: The product category's description. + * - type: array + * description: The product category's description. + * items: + * type: string + * title: description + * description: The description's details. + * - name: handle + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: handle + * description: The product category's handle. + * - type: array + * description: The product category's handle. + * items: + * type: string + * title: handle + * description: The handle's details. + * - name: parent_category_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: parent_category_id + * description: The product category's parent category id. + * - type: array + * description: The product category's parent category id. + * items: + * type: string + * title: parent_category_id + * description: The parent category id's details. + * - name: include_ancestors_tree + * in: query + * description: The product category's include ancestors tree. + * required: true + * schema: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * - name: include_descendants_tree + * in: query + * description: The product category's include descendants tree. + * required: true + * schema: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. + * - name: created_at + * in: query + * description: The product category's created at. + * required: false + * schema: + * type: object + * description: The product category's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product category's updated at. + * required: false + * schema: + * type: object + * description: The product category's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product category's deleted at. + * required: false + * schema: + * type: object + * description: The product category's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -72,10 +269,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index 4428828ac6..f36580cf93 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,46 +52,36 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - fields - * - include_ancestors_tree - * - include_descendants_tree - * properties: - * fields: - * type: string - * title: fields - * description: The product category's fields. - * include_ancestors_tree: - * type: boolean - * title: include_ancestors_tree - * description: The product category's include ancestors tree. - * include_descendants_tree: - * type: boolean - * title: include_descendants_tree - * description: The product category's include descendants tree. + * 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: include_ancestors_tree + * in: query + * description: The product category's include ancestors tree. + * required: true + * schema: + * type: boolean + * title: include_ancestors_tree + * description: The product category's include ancestors tree. + * - name: include_descendants_tree + * in: query + * description: The product category's include descendants tree. + * required: true + * schema: + * type: boolean + * title: include_descendants_tree + * description: The product category's include descendants tree. * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/store/product-categories/{id}' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "fields": "{value}", - * "include_ancestors_tree": true, - * "include_descendants_tree": false - * }' + * source: curl '{backend_url}/store/product-categories/{id}' * tags: * - Product Categories * responses: diff --git a/www/utils/generated/oas-output/operations/store/get_store_products.ts b/www/utils/generated/oas-output/operations/store/get_store_products.ts index a20dd7e3c6..22c07f3728 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,275 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: currency_code + * in: query + * description: The product's currency code. + * required: false + * schema: + * type: string + * title: currency_code + * description: The product's currency code. + * - name: region_id + * in: query + * description: The product's region id. + * required: false + * schema: + * type: string + * title: region_id + * description: The product's region id. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * - name: variants + * in: query + * description: The product's variants. + * required: false + * schema: + * type: object + * description: The product's variants. + * properties: + * status: + * type: array + * description: The variant's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * options: + * type: object + * description: The variant's options. + * required: + * - value + * - option_id + * properties: + * value: + * type: string + * title: value + * description: The option's value. + * option_id: + * type: string + * title: option_id + * description: The option's option id. + * $and: {} + * $or: {} + * - name: q + * in: query + * description: The product's q. + * required: false + * schema: + * type: string + * title: q + * description: The product's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: title + * in: query + * description: The product's title. + * required: true + * schema: + * type: string + * title: title + * description: The product's title. + * - name: handle + * in: query + * description: The product's handle. + * required: true + * schema: + * type: string + * title: handle + * description: The product's handle. + * - name: is_giftcard + * in: query + * description: The product's is giftcard. + * required: true + * schema: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * - name: category_id + * in: query + * description: The product's category id. + * required: true + * schema: + * type: array + * description: The product's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - name: sales_channel_id + * in: query + * description: The product's sales channel id. + * required: true + * schema: + * type: array + * description: The product's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * - name: collection_id + * in: query + * description: The product's collection id. + * required: true + * schema: + * type: array + * description: The product's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - name: tags + * in: query + * description: The product's tags. + * required: false + * schema: + * type: array + * description: The product's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * - name: type_id + * in: query + * description: The product's type id. + * required: false + * schema: + * type: array + * description: The product's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * - name: created_at + * in: query + * description: The product's created at. + * required: false + * schema: + * type: object + * description: The product's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product's updated at. + * required: false + * schema: + * type: object + * description: The product's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product's deleted at. + * required: false + * schema: + * type: object + * description: The product's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -53,6 +322,8 @@ * tags: * - Products * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,10 +336,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index 7be5996fea..eacfbabb62 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,275 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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: currency_code + * in: query + * description: The product's currency code. + * required: false + * schema: + * type: string + * title: currency_code + * description: The product's currency code. + * - name: region_id + * in: query + * description: The product's region id. + * required: false + * schema: + * type: string + * title: region_id + * description: The product's region id. + * - name: $and + * in: query + * required: false + * schema: {} + * - name: $or + * in: query + * required: false + * schema: {} + * - name: variants + * in: query + * description: The product's variants. + * required: false + * schema: + * type: object + * description: The product's variants. + * properties: + * status: + * type: array + * description: The variant's status. + * items: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * options: + * type: object + * description: The variant's options. + * required: + * - value + * - option_id + * properties: + * value: + * type: string + * title: value + * description: The option's value. + * option_id: + * type: string + * title: option_id + * description: The option's option id. + * $and: {} + * $or: {} + * - name: q + * in: query + * description: The product's q. + * required: false + * schema: + * type: string + * title: q + * description: The product's q. + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The product's ID. + * - type: array + * description: The product's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: title + * in: query + * description: The product's title. + * required: true + * schema: + * type: string + * title: title + * description: The product's title. + * - name: handle + * in: query + * description: The product's handle. + * required: true + * schema: + * type: string + * title: handle + * description: The product's handle. + * - name: is_giftcard + * in: query + * description: The product's is giftcard. + * required: true + * schema: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * - name: category_id + * in: query + * description: The product's category id. + * required: true + * schema: + * type: array + * description: The product's category id. + * items: + * type: string + * title: category_id + * description: The category id's details. + * - name: sales_channel_id + * in: query + * description: The product's sales channel id. + * required: true + * schema: + * type: array + * description: The product's sales channel id. + * items: + * type: string + * title: sales_channel_id + * description: The sales channel id's details. + * - name: collection_id + * in: query + * description: The product's collection id. + * required: true + * schema: + * type: array + * description: The product's collection id. + * items: + * type: string + * title: collection_id + * description: The collection id's details. + * - name: tags + * in: query + * description: The product's tags. + * required: false + * schema: + * type: array + * description: The product's tags. + * items: + * type: string + * title: tags + * description: The tag's tags. + * - name: type_id + * in: query + * description: The product's type id. + * required: false + * schema: + * type: array + * description: The product's type id. + * items: + * type: string + * title: type_id + * description: The type id's details. + * - name: created_at + * in: query + * description: The product's created at. + * required: false + * schema: + * type: object + * description: The product's created at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: updated_at + * in: query + * description: The product's updated at. + * required: false + * schema: + * type: object + * description: The product's updated at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} + * - name: deleted_at + * in: query + * description: The product's deleted at. + * required: false + * schema: + * type: object + * description: The product's deleted at. + * required: + * - $eq + * - $ne + * - $in + * - $nin + * - $like + * - $ilike + * - $re + * - $contains + * - $gt + * - $gte + * - $lt + * - $lte + * properties: + * $eq: {} + * $ne: {} + * $in: {} + * $nin: {} + * $like: {} + * $ilike: {} + * $re: {} + * $contains: {} + * $gt: {} + * $gte: {} + * $lt: {} + * $lte: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +328,8 @@ * tags: * - Products * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +342,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index 729fe8dda2..7c88b13c39 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -16,12 +16,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -40,12 +46,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -53,6 +63,8 @@ * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -65,10 +77,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts index 8c93830d61..30c7459f34 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts @@ -22,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,12 +52,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL @@ -59,6 +69,8 @@ * tags: * - Regions * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts similarity index 53% rename from www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts rename to www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index 3b7155256e..46c9bf27e3 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider]_callback.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -1,23 +1,12 @@ /** - * @oas [get] /auth/{scope}/{authProvider}/callback - * operationId: GetScopeAuthproviderCallback - * summary: List Callbacks - * description: Retrieve a list of callbacks in a [scope]. The callbacks can be - * filtered by fields like FILTER FIELDS. The callbacks can also be paginated. + * @oas [get] /store/return-reasons + * operationId: GetReturnReasons + * summary: List Return Reasons + * description: Retrieve a list of return reasons. The return reasons can be + * filtered by fields such as `id`. The return reasons can also be sorted or + * paginated. * x-authenticated: false * parameters: - * - name: scope - * in: path - * description: The [scope]'s scope. - * required: true - * schema: - * type: string - * - name: authProvider - * in: path - * description: The [scope]'s authprovider. - * required: true - * schema: - * type: string * - name: expand * in: query * description: Comma-separated relations that should be expanded in the returned data. @@ -28,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,19 +47,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/auth/{scope}/{authProvider}/callback' + * source: curl '{backend_url}/store/return-reasons' * tags: - * - "[scope]" + * - Return Reasons * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +78,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts similarity index 54% rename from www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts rename to www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts index fcf604bc18..1f94f9135a 100644 --- a/www/utils/generated/oas-output/operations/auth/get_auth_[scope]_[authProvider].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts @@ -1,20 +1,14 @@ /** - * @oas [get] /auth/{scope}/{authProvider} - * operationId: GetScopeAuthprovider - * summary: "List " - * description: Retrieve a list of in a [scope]. The can be filtered by fields - * like FILTER FIELDS. The can also be paginated. + * @oas [get] /store/return-reasons/{id} + * operationId: GetReturnReasonsId + * summary: Get a Return Reason + * description: Retrieve a return reason by its ID. You can expand the return + * reason's relations or select the fields that should be returned. * x-authenticated: false * parameters: - * - name: scope + * - name: id * in: path - * description: The [scope]'s scope. - * required: true - * schema: - * type: string - * - name: authProvider - * in: path - * description: The [scope]'s authprovider. + * description: The return reason's ID. * required: true * schema: * type: string @@ -28,12 +22,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -52,19 +52,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/auth/{scope}/{authProvider}' + * source: curl '{backend_url}/store/return-reasons/{id}' * tags: - * - "[scope]" + * - Return Reasons * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -77,10 +83,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options_[cart_id].ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts similarity index 54% rename from www/utils/generated/oas-output/operations/store/get_store_shipping-options_[cart_id].ts rename to www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index f66609c54b..90aa0db65d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options_[cart_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -1,17 +1,12 @@ /** - * @oas [get] /store/shipping-options/{cart_id} - * operationId: GetShippingOptionsCart_id - * summary: Get a Shipping Option - * description: Retrieve a shipping option by its ID. You can expand the shipping - * option's relations or select the fields that should be returned. + * @oas [get] /store/shipping-options + * operationId: GetShippingOptions + * summary: List Shipping Options + * description: Retrieve a list of shipping options. The shipping options can be + * filtered by fields such as `id`. The shipping options can also be sorted or + * paginated. * x-authenticated: false * parameters: - * - name: cart_id - * in: path - * description: The shipping option's cart id. - * required: true - * schema: - * type: string * - name: expand * in: query * description: Comma-separated relations that should be expanded in the returned data. @@ -22,12 +17,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -46,19 +47,25 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl '{backend_url}/store/shipping-options/{cart_id}' + * source: curl '{backend_url}/store/shipping-options' * tags: * - Shipping Options * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -71,10 +78,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index b28a712877..3f6850252c 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: @@ -57,6 +67,8 @@ * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index f4f0cef57b..d8faa8709c 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: @@ -63,6 +73,8 @@ * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts index 828562e71b..8fc9e014ec 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_complete.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,20 +51,22 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: * schema: * type: object * description: SUMMARY - * required: - * - idempotency_key * properties: * idempotency_key: * type: string @@ -67,15 +75,12 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl -X POST '{backend_url}/store/carts/{id}/complete' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "idempotency_key": "{value}" - * }' + * source: curl -X POST '{backend_url}/store/carts/{id}/complete' * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index d916d8a3bf..347caa8ff3 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,19 +51,37 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreAddCartLineItem" * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/store/carts/{id}/line-items' + * source: |- + * curl -X POST '{backend_url}/store/carts/{id}/line-items' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "variant_id": "{value}", + * "quantity": 3360689747918848, + * "metadata": {} + * }' * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,28 +94,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - variant_id - * - quantity - * - metadata - * properties: - * variant_id: - * type: string - * title: variant_id - * description: The cart's variant id. - * quantity: - * type: number - * title: quantity - * description: The cart's quantity. - * metadata: - * type: object - * description: The cart's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 64286603b7..48b80ca62f 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -27,12 +27,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -51,19 +57,36 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreUpdateCartLineItem" * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' + * source: |- + * curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "quantity": 8980402259623936, + * "metadata": {} + * }' * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -76,23 +99,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - quantity - * - metadata - * properties: - * quantity: - * type: number - * title: quantity - * description: The cart's quantity. - * metadata: - * type: object - * description: The cart's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts deleted file mode 100644 index 8800fce79c..0000000000 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_payment-collections.ts +++ /dev/null @@ -1,253 +0,0 @@ -/** - * @oas [post] /store/carts/{id}/payment-collections - * operationId: PostCartsIdPaymentCollections - * summary: Add Payment Collections to Cart - * description: Add a list of payment collections to a cart. - * x-authenticated: false - * parameters: - * - name: id - * in: path - * description: The cart's ID. - * required: true - * schema: - * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: Field to sort items in the list by. - * required: false - * schema: - * type: string - * title: order - * description: Field to sort items in the list by. - * requestBody: - * content: - * application/json: - * schema: - * type: object - * description: SUMMARY - * required: - * - region_id - * - email - * - billing_address - * - shipping_address - * - sales_channel_id - * - metadata - * - promo_codes - * properties: - * region_id: - * type: string - * title: region_id - * description: The cart's region id. - * email: - * type: string - * title: email - * description: The cart's email. - * format: email - * billing_address: - * oneOf: - * - type: string - * title: billing_address - * description: The cart's billing address. - * - type: object - * description: The cart's billing address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata - * properties: - * first_name: - * type: string - * title: first_name - * description: The billing address's first name. - * last_name: - * type: string - * title: last_name - * description: The billing address's last name. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * company: - * type: string - * title: company - * description: The billing address's company. - * address_1: - * type: string - * title: address_1 - * description: The billing address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The billing address's address 2. - * city: - * type: string - * title: city - * description: The billing address's city. - * country_code: - * type: string - * title: country_code - * description: The billing address's country code. - * province: - * type: string - * title: province - * description: The billing address's province. - * postal_code: - * type: string - * title: postal_code - * description: The billing address's postal code. - * metadata: - * type: object - * description: The billing address's metadata. - * properties: {} - * shipping_address: - * oneOf: - * - type: string - * title: shipping_address - * description: The cart's shipping address. - * - type: object - * description: The cart's shipping address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata - * properties: - * first_name: - * type: string - * title: first_name - * description: The shipping address's first name. - * last_name: - * type: string - * title: last_name - * description: The shipping address's last name. - * phone: - * type: string - * title: phone - * description: The shipping address's phone. - * company: - * type: string - * title: company - * description: The shipping address's company. - * address_1: - * type: string - * title: address_1 - * description: The shipping address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The shipping address's address 2. - * city: - * type: string - * title: city - * description: The shipping address's city. - * country_code: - * type: string - * title: country_code - * description: The shipping address's country code. - * province: - * type: string - * title: province - * description: The shipping address's province. - * postal_code: - * type: string - * title: postal_code - * description: The shipping address's postal code. - * metadata: - * type: object - * description: The shipping address's metadata. - * properties: {} - * sales_channel_id: - * type: string - * title: sales_channel_id - * description: The cart's sales channel id. - * metadata: - * type: object - * description: The cart's metadata. - * properties: {} - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. - * x-codeSamples: - * - lang: Shell - * label: cURL - * source: |- - * curl -X POST '{backend_url}/store/carts/{id}/payment-collections' \ - * -H 'Content-Type: application/json' \ - * --data-raw '{ - * "region_id": "{value}", - * "email": "Greyson3@gmail.com", - * "sales_channel_id": "{value}", - * "metadata": {}, - * "promo_codes": [ - * "{value}" - * ] - * }' - * tags: - * - Carts - * responses: - * "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" - * -*/ - diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts index e27af902d9..18c4207e2d 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,19 +51,48 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - promo_codes + * properties: + * promo_codes: + * type: array + * description: The cart's promo codes. + * items: + * type: string + * title: promo_codes + * description: The promo code's promo codes. * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/store/carts/{id}/promotions' + * source: |- + * curl -X POST '{backend_url}/store/carts/{id}/promotions' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "promo_codes": [ + * "{value}" + * ] + * }' * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -70,21 +105,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - promo_codes - * properties: - * promo_codes: - * type: array - * description: The cart's promo codes. - * items: - * type: string - * title: promo_codes - * description: The promo code's promo codes. * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index ccfb3a9188..c26f218903 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,16 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: @@ -59,7 +69,6 @@ * description: SUMMARY * required: * - option_id - * - data * properties: * option_id: * type: string @@ -68,7 +77,6 @@ * data: * type: object * description: The cart's data. - * properties: {} * x-codeSamples: * - lang: Shell * label: cURL @@ -76,12 +84,13 @@ * curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \ * -H 'Content-Type: application/json' \ * --data-raw '{ - * "option_id": "{value}", - * "data": {} + * "option_id": "{value}" * }' * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts index 571115409f..661bf82f53 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,25 +51,21 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: * schema: - * type: object - * description: SUMMARY - * properties: - * fields: - * type: string - * title: fields - * description: The cart's fields. - * required: - * - fields + * $ref: "#/components/schemas/StoreCalculateCartTaxes" * x-codeSamples: * - lang: Shell * label: cURL @@ -71,6 +73,8 @@ * tags: * - Carts * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers.ts b/www/utils/generated/oas-output/operations/store/post_store_customers.ts index d198db9164..692f556515 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers.ts @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,19 +45,39 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StoreCreateCustomer" * x-codeSamples: * - lang: Shell * label: cURL - * source: curl -X POST '{backend_url}/store/customers' + * source: |- + * curl -X POST '{backend_url}/store/customers' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "email": "Monserrate.Leannon88@yahoo.com", + * "company_name": "{value}", + * "first_name": "{value}", + * "last_name": "{value}", + * "phone": "{value}" + * }' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -64,39 +90,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: - * type: object - * required: - * - email - * - company_name - * - first_name - * - last_name - * - phone - * properties: - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 570003e89c..95275cd784 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -3,7 +3,7 @@ * operationId: PostCustomersMe * summary: Create Customer * description: Create a customer. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: expand * in: query @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,45 +45,30 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * requestBody: * content: * application/json: * schema: - * type: object - * description: SUMMARY - * required: - * - company_name - * - first_name - * - last_name - * - phone - * properties: - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * phone: - * type: string - * title: phone - * description: The customer's phone. + * $ref: "#/components/schemas/StoreUpdateCustomer" * x-codeSamples: * - lang: Shell * label: cURL * source: |- * curl -X POST '{backend_url}/store/customers/me' \ + * -H 'Authorization: Bearer {access_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ * "company_name": "{value}", @@ -88,6 +79,8 @@ * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index f6de0ef859..f37db3112e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -3,7 +3,7 @@ * operationId: PostCustomersMeAddresses * summary: Create Customer * description: Create a customer. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: expand * in: query @@ -15,12 +15,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -39,12 +45,19 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * requestBody: * content: * application/json: @@ -64,13 +77,10 @@ * - province * - postal_code * - address_name - * - is_default_shipping - * - is_default_billing * properties: * metadata: * type: object * description: The customer's metadata. - * properties: {} * first_name: * type: string * title: first_name @@ -128,6 +138,7 @@ * label: cURL * source: |- * curl -X POST '{backend_url}/store/customers/me/addresses' \ + * -H 'Authorization: Bearer {access_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ * "metadata": {}, @@ -141,13 +152,13 @@ * "country_code": "{value}", * "province": "{value}", * "postal_code": "{value}", - * "address_name": "{value}", - * "is_default_shipping": false, - * "is_default_billing": true + * "address_name": "{value}" * }' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index 56ccc24b1d..a590c85e24 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -3,7 +3,7 @@ * operationId: PostCustomersMeAddressesAddress_id * summary: Add Addresses to Customer * description: Add a list of addresses to a customer. - * x-authenticated: false + * x-authenticated: true * parameters: * - name: address_id * in: path @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,12 +51,19 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * security: + * - cookie_auth: [] + * - jwt_token: [] * requestBody: * content: * application/json: @@ -70,13 +83,10 @@ * - province * - postal_code * - address_name - * - is_default_shipping - * - is_default_billing * properties: * metadata: * type: object * description: The customer's metadata. - * properties: {} * first_name: * type: string * title: first_name @@ -134,6 +144,7 @@ * label: cURL * source: |- * curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \ + * -H 'Authorization: Bearer {access_token}' \ * -H 'Content-Type: application/json' \ * --data-raw '{ * "metadata": {}, @@ -147,13 +158,13 @@ * "country_code": "{value}", * "province": "{value}", * "postal_code": "{value}", - * "address_name": "{value}", - * "is_default_shipping": true, - * "is_default_billing": false + * "address_name": "{value}" * }' * tags: * - Customers * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts new file mode 100644 index 0000000000..2eadf72d12 --- /dev/null +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -0,0 +1,117 @@ +/** + * @oas [post] /store/payment-collections + * operationId: PostPaymentCollections + * summary: Create Payment Collection + * description: Create a payment collection. + * x-authenticated: false + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - cart_id + * - region_id + * - currency_code + * - amount + * properties: + * cart_id: + * type: string + * title: cart_id + * description: The payment collection's cart id. + * region_id: + * type: string + * title: region_id + * description: The payment collection's region id. + * currency_code: + * type: string + * title: currency_code + * description: The payment collection's currency code. + * amount: + * type: number + * title: amount + * description: The payment collection's amount. + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/store/payment-collections' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "cart_id": "{value}", + * "region_id": "{value}", + * "currency_code": "{value}", + * "amount": 8468325826822144 + * }' + * tags: + * - Payment Collections + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts index 7a3394a7ac..5d458ab07d 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections_[id]_payment-sessions.ts @@ -21,12 +21,18 @@ * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query - * description: Comma-separated fields that should be included in the returned data. + * 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. + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. @@ -45,17 +51,35 @@ * description: Limit the number of items returned in the list. * - name: order * in: query - * description: Field to sort items in the list by. + * 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: Field to sort items in the list by. + * 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 + * `-`. * requestBody: * content: * application/json: * schema: - * $ref: "#/components/schemas/StorePostPaymentCollectionsPaymentSessionReq" + * type: object + * description: SUMMARY + * required: + * - provider_id + * properties: + * provider_id: + * type: string + * title: provider_id + * description: The payment collection's provider id. + * context: + * type: object + * description: The payment collection's context. + * data: + * type: object + * description: The payment collection's data. * x-codeSamples: * - lang: Shell * label: cURL @@ -71,6 +95,8 @@ * tags: * - Payment Collections * responses: + * "200": + * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/store/post_store_return.ts b/www/utils/generated/oas-output/operations/store/post_store_return.ts new file mode 100644 index 0000000000..3055f94461 --- /dev/null +++ b/www/utils/generated/oas-output/operations/store/post_store_return.ts @@ -0,0 +1,105 @@ +/** + * @oas [post] /store/return + * operationId: PostReturn + * summary: Create Return + * description: Create a return. + * x-authenticated: false + * parameters: + * - name: expand + * in: query + * description: Comma-separated relations that should be expanded in the returned data. + * required: false + * schema: + * type: string + * title: expand + * description: Comma-separated relations that should be expanded in the returned data. + * - name: fields + * in: query + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * required: false + * schema: + * type: string + * title: fields + * description: >- + * Comma-separated fields that should be included in the returned data. + * * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. + * * without prefix it will replace the entire default fields. + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * - name: order + * in: query + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is + * ascending. To change the order to descending, prefix the field name with + * `-`. + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/StorePostReturnsReqSchema" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/store/return' \ + * -H 'Content-Type: application/json' \ + * --data-raw '{ + * "order_id": "{value}", + * "items": [ + * { + * "id": "id_XbfptxUVo2io9EI", + * "quantity": 7916429753974784, + * "reason_id": "{value}", + * "note": "{value}" + * } + * ], + * "return_shipping": { + * "option_id": "{value}", + * "price": 1068364080349184 + * }, + * "note": "{value}", + * "location_id": "{value}" + * }' + * tags: + * - Return + * 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" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts b/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts new file mode 100644 index 0000000000..39b4c9c0fa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts @@ -0,0 +1,15 @@ +/** + * @schema AdminArchiveOrder + * type: object + * description: SUMMARY + * x-schemaName: AdminArchiveOrder + * required: + * - order_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The order's order id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductRequest.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductRequest.ts new file mode 100644 index 0000000000..61e961360b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductRequest.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminBatchProductRequest + * type: object + * description: SUMMARY + * x-schemaName: AdminBatchProductRequest + * properties: + * create: + * type: array + * description: The product's create. + * items: + * $ref: "#/components/schemas/AdminCreateProduct" + * update: + * type: array + * description: The product's update. + * items: + * $ref: "#/components/schemas/AdminUpdateProduct" + * delete: + * type: array + * description: The product's delete. + * items: + * type: string + * title: delete + * description: The delete's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts new file mode 100644 index 0000000000..8fef743e96 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductResponse.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminBatchProductResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminBatchProductResponse + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The product's created. + * items: + * $ref: "#/components/schemas/AdminProduct" + * updated: + * type: array + * description: The product's updated. + * items: + * $ref: "#/components/schemas/AdminProduct" + * deleted: + * type: object + * description: The product's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductVariantRequest.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantRequest.ts new file mode 100644 index 0000000000..6099c611d5 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantRequest.ts @@ -0,0 +1,26 @@ +/** + * @schema AdminBatchProductVariantRequest + * type: object + * description: SUMMARY + * x-schemaName: AdminBatchProductVariantRequest + * properties: + * create: + * type: array + * description: The product's create. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariant" + * update: + * type: array + * description: The product's update. + * items: + * $ref: "#/components/schemas/AdminUpdateProductVariant" + * delete: + * type: array + * description: The product's delete. + * items: + * type: string + * title: delete + * description: The delete's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts new file mode 100644 index 0000000000..3be907982e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminBatchProductVariantResponse.ts @@ -0,0 +1,46 @@ +/** + * @schema AdminBatchProductVariantResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminBatchProductVariantResponse + * required: + * - created + * - updated + * - deleted + * properties: + * created: + * type: array + * description: The product's created. + * items: + * $ref: "#/components/schemas/AdminProductVariant" + * updated: + * type: array + * description: The product's updated. + * items: + * $ref: "#/components/schemas/AdminProductVariant" + * deleted: + * type: object + * description: The product's deleted. + * required: + * - ids + * - object + * - deleted + * properties: + * ids: + * type: array + * description: The deleted's ids. + * items: + * type: string + * title: ids + * description: The id's ids. + * object: + * type: string + * title: object + * description: The deleted's object. + * deleted: + * type: boolean + * title: deleted + * description: The deleted's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCancelFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCancelFulfillment.ts new file mode 100644 index 0000000000..39864256ff --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCancelFulfillment.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminCancelFulfillment + * type: object + * description: SUMMARY + * x-schemaName: AdminCancelFulfillment + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCollection.ts b/www/utils/generated/oas-output/schemas/AdminCollection.ts new file mode 100644 index 0000000000..176e2d895d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCollection.ts @@ -0,0 +1,44 @@ +/** + * @schema AdminCollection + * type: object + * description: The parent's collection. + * x-schemaName: AdminCollection + * properties: + * id: + * type: string + * title: id + * description: The collection's ID. + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The collection's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The collection's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The collection's deleted at. + * products: + * type: array + * description: The collection's products. + * items: + * $ref: "#/components/schemas/AdminProduct" + * metadata: + * type: object + * description: The collection's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts b/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts new file mode 100644 index 0000000000..85a478d97e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCompleteOrder.ts @@ -0,0 +1,15 @@ +/** + * @schema AdminCompleteOrder + * type: object + * description: SUMMARY + * x-schemaName: AdminCompleteOrder + * required: + * - order_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The order's order id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts b/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts new file mode 100644 index 0000000000..b6634d1f26 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateApiKey.ts @@ -0,0 +1,21 @@ +/** + * @schema AdminCreateApiKey + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateApiKey + * required: + * - title + * - type + * properties: + * title: + * type: string + * title: title + * description: The api key's title. + * type: + * type: string + * enum: + * - publishable + * - secret + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts b/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts new file mode 100644 index 0000000000..6653a61def --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminCreateCollection + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateCollection + * required: + * - title + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * metadata: + * type: object + * description: The collection's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts new file mode 100644 index 0000000000..5a8e9a2ab7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateCustomer.ts @@ -0,0 +1,40 @@ +/** + * @schema AdminCreateCustomer + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateCustomer + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * - metadata + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts new file mode 100644 index 0000000000..0c8c996e31 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateCustomerAddress.ts @@ -0,0 +1,77 @@ +/** + * @schema AdminCreateCustomerAddress + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateCustomerAddress + * required: + * - address_name + * - company + * - first_name + * - last_name + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - phone + * - metadata + * properties: + * address_name: + * type: string + * title: address_name + * description: The customer's address name. + * is_default_shipping: + * type: boolean + * title: is_default_shipping + * description: The customer's is default shipping. + * is_default_billing: + * type: boolean + * title: is_default_billing + * description: The customer's is default billing. + * company: + * type: string + * title: company + * description: The customer's company. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * address_1: + * type: string + * title: address_1 + * description: The customer's address 1. + * address_2: + * type: string + * title: address_2 + * description: The customer's address 2. + * city: + * type: string + * title: city + * description: The customer's city. + * country_code: + * type: string + * title: country_code + * description: The customer's country code. + * province: + * type: string + * title: province + * description: The customer's province. + * postal_code: + * type: string + * title: postal_code + * description: The customer's postal code. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts new file mode 100644 index 0000000000..6c8b41c6bf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts @@ -0,0 +1,19 @@ +/** + * @schema AdminCreateCustomerGroup + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateCustomerGroup + * required: + * - name + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The customer group's name. + * metadata: + * type: object + * description: The customer group's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts new file mode 100644 index 0000000000..4587bff9c1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -0,0 +1,189 @@ +/** + * @schema AdminCreateFulfillment + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateFulfillment + * required: + * - location_id + * - provider_id + * - delivery_address + * - items + * - labels + * - order + * - order_id + * - shipping_option_id + * - data + * - packed_at + * - shipped_at + * - delivered_at + * - canceled_at + * - metadata + * properties: + * location_id: + * type: string + * title: location_id + * description: The fulfillment's location id. + * provider_id: + * type: string + * title: provider_id + * description: The fulfillment's provider id. + * delivery_address: + * type: object + * description: The fulfillment's delivery address. + * required: + * - first_name + * - last_name + * - phone + * - company + * - address_1 + * - address_2 + * - city + * - country_code + * - province + * - postal_code + * - metadata + * properties: + * first_name: + * type: string + * title: first_name + * description: The delivery address's first name. + * last_name: + * type: string + * title: last_name + * description: The delivery address's last name. + * phone: + * type: string + * title: phone + * description: The delivery address's phone. + * company: + * type: string + * title: company + * description: The delivery address's company. + * address_1: + * type: string + * title: address_1 + * description: The delivery address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The delivery address's address 2. + * city: + * type: string + * title: city + * description: The delivery address's city. + * country_code: + * type: string + * title: country_code + * description: The delivery address's country code. + * province: + * type: string + * title: province + * description: The delivery address's province. + * postal_code: + * type: string + * title: postal_code + * description: The delivery address's postal code. + * metadata: + * type: object + * description: The delivery address's metadata. + * items: + * type: array + * description: The fulfillment's items. + * items: + * type: object + * description: The item's items. + * required: + * - title + * - sku + * - quantity + * - barcode + * - line_item_id + * - inventory_item_id + * properties: + * title: + * type: string + * title: title + * description: The item's title. + * sku: + * type: string + * title: sku + * description: The item's sku. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * barcode: + * type: string + * title: barcode + * description: The item's barcode. + * line_item_id: + * type: string + * title: line_item_id + * description: The item's line item id. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The item's inventory item id. + * labels: + * type: array + * description: The fulfillment's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * order: + * type: object + * description: The fulfillment's order. + * order_id: + * type: string + * title: order_id + * description: The fulfillment's order id. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The fulfillment's shipping option id. + * data: + * type: object + * description: The fulfillment's data. + * packed_at: + * type: string + * title: packed_at + * description: The fulfillment's packed at. + * format: date-time + * shipped_at: + * type: string + * title: shipped_at + * description: The fulfillment's shipped at. + * format: date-time + * delivered_at: + * type: string + * title: delivered_at + * description: The fulfillment's delivered at. + * format: date-time + * canceled_at: + * type: string + * title: canceled_at + * description: The fulfillment's canceled at. + * format: date-time + * metadata: + * type: object + * description: The fulfillment's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts new file mode 100644 index 0000000000..261da8ee9c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts @@ -0,0 +1,79 @@ +/** + * @schema AdminCreatePriceList + * type: object + * description: SUMMARY + * x-schemaName: AdminCreatePriceList + * required: + * - title + * - description + * - starts_at + * - ends_at + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: + * type: string + * enum: + * - active + * - draft + * type: + * type: string + * enum: + * - sale + * - override + * rules: + * type: object + * description: The price list's rules. + * prices: + * type: array + * description: The price list's prices. + * items: + * type: object + * description: The price's prices. + * required: + * - currency_code + * - amount + * - variant_id + * - min_quantity + * - max_quantity + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * variant_id: + * type: string + * title: variant_id + * description: The price's variant id. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * rules: + * type: object + * description: The price's rules. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts new file mode 100644 index 0000000000..e7fa541d14 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProduct.ts @@ -0,0 +1,153 @@ +/** + * @schema AdminCreateProduct + * type: object + * description: The create's details. + * x-schemaName: AdminCreateProduct + * required: + * - title + * properties: + * title: + * type: string + * title: title + * description: The create's title. + * subtitle: + * type: string + * title: subtitle + * description: The create's subtitle. + * description: + * type: string + * title: description + * description: The create's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The create's is giftcard. + * discountable: + * type: boolean + * title: discountable + * description: The create's discountable. + * images: + * type: array + * description: The create's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * thumbnail: + * type: string + * title: thumbnail + * description: The create's thumbnail. + * handle: + * type: string + * title: handle + * description: The create's handle. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * type_id: + * type: string + * title: type_id + * description: The create's type id. + * collection_id: + * type: string + * title: collection_id + * description: The create's collection id. + * categories: + * type: array + * description: The create's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * tags: + * type: array + * description: The create's tags. + * items: + * type: object + * description: The tag's tags. + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * value: + * type: string + * title: value + * description: The tag's value. + * options: + * type: array + * description: The create's options. + * items: + * $ref: "#/components/schemas/AdminCreateProductOption" + * variants: + * type: array + * description: The create's variants. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariant" + * sales_channels: + * type: array + * description: The create's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * weight: + * type: number + * title: weight + * description: The create's weight. + * length: + * type: number + * title: length + * description: The create's length. + * height: + * type: number + * title: height + * description: The create's height. + * width: + * type: number + * title: width + * description: The create's width. + * hs_code: + * type: string + * title: hs_code + * description: The create's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The create's mid code. + * origin_country: + * type: string + * title: origin_country + * description: The create's origin country. + * material: + * type: string + * title: material + * description: The create's material. + * metadata: + * type: object + * description: The create's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductOption.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductOption.ts new file mode 100644 index 0000000000..687205ce54 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductOption.ts @@ -0,0 +1,23 @@ +/** + * @schema AdminCreateProductOption + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateProductOption + * required: + * - title + * - values + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts new file mode 100644 index 0000000000..bc06f44ab0 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts @@ -0,0 +1,87 @@ +/** + * @schema AdminCreateProductVariant + * type: object + * description: The create's details. + * x-schemaName: AdminCreateProductVariant + * required: + * - title + * - prices + * properties: + * title: + * type: string + * title: title + * description: The create's title. + * sku: + * type: string + * title: sku + * description: The create's sku. + * ean: + * type: string + * title: ean + * description: The create's ean. + * upc: + * type: string + * title: upc + * description: The create's upc. + * barcode: + * type: string + * title: barcode + * description: The create's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The create's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The create's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The create's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The create's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The create's variant rank. + * weight: + * type: number + * title: weight + * description: The create's weight. + * length: + * type: number + * title: length + * description: The create's length. + * height: + * type: number + * title: height + * description: The create's height. + * width: + * type: number + * title: width + * description: The create's width. + * origin_country: + * type: string + * title: origin_country + * description: The create's origin country. + * material: + * type: string + * title: material + * description: The create's material. + * metadata: + * type: object + * description: The create's metadata. + * prices: + * type: array + * description: The create's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The create's options. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductVariantPrice.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductVariantPrice.ts new file mode 100644 index 0000000000..01171e70e1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductVariantPrice.ts @@ -0,0 +1,28 @@ +/** + * @schema AdminCreateProductVariantPrice + * type: object + * description: The price's prices. + * x-schemaName: AdminCreateProductVariantPrice + * 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. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts new file mode 100644 index 0000000000..e22828d90d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateSalesChannel.ts @@ -0,0 +1,28 @@ +/** + * @schema AdminCreateSalesChannel + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateSalesChannel + * required: + * - name + * - description + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The sales channel's name. + * description: + * type: string + * title: description + * description: The sales channel's description. + * is_disabled: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * metadata: + * type: object + * description: The sales channel's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts b/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts new file mode 100644 index 0000000000..0ee77ee5a9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateShipment.ts @@ -0,0 +1,34 @@ +/** + * @schema AdminCreateShipment + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateShipment + * required: + * - labels + * properties: + * labels: + * type: array + * description: The fulfillment's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts new file mode 100644 index 0000000000..4fe5f863e5 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateStockLocation.ts @@ -0,0 +1,69 @@ +/** + * @schema AdminCreateStockLocation + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateStockLocation + * required: + * - name + * - address_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The stock location's name. + * address: + * type: object + * description: The stock location's address. + * required: + * - address_1 + * - address_2 + * - company + * - city + * - country_code + * - phone + * - postal_code + * - province + * properties: + * address_1: + * type: string + * title: address_1 + * description: The address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The address's address 2. + * company: + * type: string + * title: company + * description: The address's company. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * phone: + * type: string + * title: phone + * description: The address's phone. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * province: + * type: string + * title: province + * description: The address's province. + * address_id: + * type: string + * title: address_id + * description: The stock location's address id. + * metadata: + * type: object + * description: The stock location's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts new file mode 100644 index 0000000000..9b70339d88 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts @@ -0,0 +1,58 @@ +/** + * @schema AdminCreateTaxRate + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateTaxRate + * required: + * - name + * - tax_region_id + * - metadata + * properties: + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * code: + * type: string + * title: code + * description: The tax rate's code. + * rules: + * type: array + * description: The tax rate's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The rule's reference. + * reference_id: + * type: string + * title: reference_id + * description: The rule's reference id. + * name: + * type: string + * title: name + * description: The tax rate's name. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * tax_region_id: + * type: string + * title: tax_region_id + * description: The tax rate's tax region id. + * metadata: + * type: object + * description: The tax rate's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRateRule.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRateRule.ts new file mode 100644 index 0000000000..f9217e8b55 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRateRule.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminCreateTaxRateRule + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateTaxRateRule + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The tax rate's reference. + * reference_id: + * type: string + * title: reference_id + * description: The tax rate's reference id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts new file mode 100644 index 0000000000..e3ed41bdb4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts @@ -0,0 +1,56 @@ +/** + * @schema AdminCreateTaxRegion + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateTaxRegion + * required: + * - country_code + * - province_code + * - parent_id + * - metadata + * properties: + * country_code: + * type: string + * title: country_code + * description: The tax region's country code. + * province_code: + * type: string + * title: province_code + * description: The tax region's province code. + * parent_id: + * type: string + * title: parent_id + * description: The tax region's parent id. + * default_tax_rate: + * type: object + * description: The tax region's default tax rate. + * required: + * - name + * - metadata + * properties: + * rate: + * type: number + * title: rate + * description: The default tax rate's rate. + * code: + * type: string + * title: code + * description: The default tax rate's code. + * name: + * type: string + * title: name + * description: The default tax rate's name. + * is_combinable: + * type: string + * enum: + * - "true" + * - "false" + * metadata: + * type: object + * description: The default tax rate's metadata. + * metadata: + * type: object + * description: The tax region's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts new file mode 100644 index 0000000000..fa2bbaee2c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminCreateVariantInventoryItem + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateVariantInventoryItem + * required: + * - required_quantity + * - inventory_item_id + * properties: + * required_quantity: + * type: number + * title: required_quantity + * description: The product's required quantity. + * inventory_item_id: + * type: string + * title: inventory_item_id + * description: The product's inventory item id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts new file mode 100644 index 0000000000..73d8703e73 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsAsyncResponse.ts @@ -0,0 +1,27 @@ +/** + * @schema AdminCreateWorkflowsAsyncResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateWorkflowsAsyncResponse + * required: + * - transaction_id + * - step_id + * properties: + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * step_id: + * type: string + * title: step_id + * description: The workflows execution's step id. + * response: {} + * compensate_input: {} + * action: + * type: string + * enum: + * - invoke + * - compensate + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsRun.ts b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsRun.ts new file mode 100644 index 0000000000..44b22338ac --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateWorkflowsRun.ts @@ -0,0 +1,14 @@ +/** + * @schema AdminCreateWorkflowsRun + * type: object + * description: SUMMARY + * x-schemaName: AdminCreateWorkflowsRun + * properties: + * input: {} + * transaction_id: + * type: string + * title: transaction_id + * description: The workflows execution's transaction id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CustomerResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomer.ts similarity index 64% rename from www/utils/generated/oas-output/schemas/CustomerResponse.ts rename to www/utils/generated/oas-output/schemas/AdminCustomer.ts index 360ac3e287..3f0e5dfa2d 100644 --- a/www/utils/generated/oas-output/schemas/CustomerResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomer.ts @@ -1,9 +1,10 @@ /** - * @schema CustomerResponse + * @schema AdminCustomer * type: object * description: The customer's details. - * x-schemaName: CustomerResponse + * x-schemaName: AdminCustomer * required: + * - has_account * - id * - email * - default_billing_address_id @@ -11,9 +12,17 @@ * - company_name * - first_name * - last_name - * - has_account * - addresses * properties: + * has_account: + * type: boolean + * title: has_account + * description: The customer's has account. + * groups: + * type: array + * description: The customer's groups. + * items: + * $ref: "#/components/schemas/AdminCustomerGroup" * id: * type: string * title: id @@ -43,59 +52,37 @@ * type: string * title: last_name * description: The customer's last name. - * has_account: - * type: boolean - * title: has_account - * description: The customer's has account. * addresses: * type: array * description: The customer's addresses. * items: - * $ref: "#/components/schemas/CustomerAddressResponse" + * $ref: "#/components/schemas/BaseCustomerAddress" * phone: * type: string * title: phone * description: The customer's phone. - * groups: - * type: array - * description: The customer's groups. - * items: - * $ref: "#/components/schemas/CustomerGroupResponse" * metadata: * type: object * description: The customer's metadata. - * properties: {} * created_by: * type: string * title: created_by * description: The customer's created by. * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * format: date-time + * type: string + * format: date-time + * title: deleted_at + * description: The customer's deleted at. * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The customer's created at. - * - type: string - * title: created_at - * description: The customer's created at. - * format: date-time + * type: string + * format: date-time + * title: created_at + * description: The customer's created at. * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The customer's updated at. - * - type: string - * title: updated_at - * description: The customer's updated at. - * format: date-time + * type: string + * format: date-time + * title: updated_at + * description: The customer's updated at. * */ diff --git a/www/utils/generated/oas-output/schemas/CustomerGroupResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts similarity index 81% rename from www/utils/generated/oas-output/schemas/CustomerGroupResponse.ts rename to www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts index 9c7c54831c..b6d6fea046 100644 --- a/www/utils/generated/oas-output/schemas/CustomerGroupResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts @@ -1,8 +1,8 @@ /** - * @schema CustomerGroupResponse + * @schema AdminCustomerGroup * type: object * description: The group's groups. - * x-schemaName: CustomerGroupResponse + * x-schemaName: AdminCustomerGroup * required: * - id * - name @@ -23,17 +23,18 @@ * type: array * description: The group's customers. * items: - * $ref: "#/components/schemas/CustomerResponse" + * $ref: "#/components/schemas/BaseCustomer" * metadata: * type: object * description: The group's metadata. - * properties: {} * created_at: * type: string + * format: date-time * title: created_at * description: The group's created at. * updated_at: * type: string + * format: date-time * title: updated_at * description: The group's updated at. * diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerListResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerListResponse.ts deleted file mode 100644 index aec6124a68..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCustomerListResponse.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * @schema AdminCustomerListResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminCustomerListResponse - * required: - * - customers - * - limit - * - offset - * - count - * properties: - * customers: - * type: array - * description: The customer's customers. - * items: - * $ref: "#/components/schemas/CustomerResponse" - * limit: - * type: number - * title: limit - * description: The customer's limit. - * offset: - * type: number - * title: offset - * description: The customer's offset. - * count: - * type: number - * title: count - * description: The customer's count. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts b/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts deleted file mode 100644 index b3c9f0daa1..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCustomerResponse.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminCustomerResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminCustomerResponse - * required: - * - customer - * properties: - * customer: - * $ref: "#/components/schemas/CustomerResponse" - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts new file mode 100644 index 0000000000..5df4ed9f41 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentProvider.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminFulfillmentProvider + * type: object + * description: The shipping option's provider. + * x-schemaName: AdminFulfillmentProvider + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderResponse.ts deleted file mode 100644 index 65ba0534ba..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentProviderResponse.ts +++ /dev/null @@ -1,43 +0,0 @@ -/** - * @schema AdminFulfillmentProviderResponse - * type: object - * description: The shipping option's provider. - * x-schemaName: AdminFulfillmentProviderResponse - * required: - * - id - * - name - * - metadata - * - created_at - * - updated_at - * - deleted_at - * properties: - * id: - * type: string - * title: id - * description: The provider's ID. - * name: - * type: string - * title: name - * description: The provider's name. - * metadata: - * type: object - * description: The provider's metadata. - * properties: {} - * created_at: - * type: string - * title: created_at - * description: The provider's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The provider's updated at. - * format: date-time - * deleted_at: - * type: string - * title: deleted_at - * description: The provider's deleted at. - * format: date-time - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/FulfillmentSetResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts similarity index 51% rename from www/utils/generated/oas-output/schemas/FulfillmentSetResponse.ts rename to www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts index 153215bc3b..18a1a52518 100644 --- a/www/utils/generated/oas-output/schemas/FulfillmentSetResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSet.ts @@ -1,13 +1,12 @@ /** - * @schema FulfillmentSetResponse + * @schema AdminFulfillmentSet * type: object - * description: The fulfillment set's parent. - * x-schemaName: FulfillmentSetResponse + * description: The fulfillment set's details. + * x-schemaName: AdminFulfillmentSet * required: * - id * - name * - type - * - metadata * - service_zones * - created_at * - updated_at @@ -16,39 +15,35 @@ * id: * type: string * title: id - * description: The parent's ID. + * description: The fulfillment set's ID. * name: * type: string * title: name - * description: The parent's name. + * description: The fulfillment set's name. * type: * type: string * title: type - * description: The parent's type. - * metadata: - * type: object - * description: The parent's metadata. - * properties: {} + * description: The fulfillment set's type. * service_zones: * type: array - * description: The parent's service zones. + * description: The fulfillment set's service zones. * items: - * $ref: "#/components/schemas/ServiceZoneResponse" + * $ref: "#/components/schemas/AdminServiceZone" * created_at: * type: string - * title: created_at - * description: The parent's created at. * format: date-time + * title: created_at + * description: The fulfillment set's created at. * updated_at: * type: string - * title: updated_at - * description: The parent's updated at. * format: date-time + * title: updated_at + * description: The fulfillment set's updated at. * deleted_at: * type: string - * title: deleted_at - * description: The parent's deleted at. * format: date-time + * title: deleted_at + * description: The fulfillment set's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts similarity index 68% rename from www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts rename to www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts index 491ed4fad4..73637ed0fd 100644 --- a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetDeleteResponse.ts @@ -1,13 +1,12 @@ /** - * @schema AdminServiceZoneDeleteResponse + * @schema AdminFulfillmentSetDeleteResponse * type: object * description: SUMMARY - * x-schemaName: AdminServiceZoneDeleteResponse + * x-schemaName: AdminFulfillmentSetDeleteResponse * required: * - id * - object * - deleted - * - parent * properties: * id: * type: string @@ -17,12 +16,14 @@ * type: string * title: object * description: The fulfillment set's object. + * default: fulfillment_set * deleted: * type: boolean * title: deleted * description: The fulfillment set's deleted. * parent: - * $ref: "#/components/schemas/FulfillmentSetResponse" + * type: object + * description: The fulfillment set's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetResponse.ts index ba939aba85..98b6093e49 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetResponse.ts @@ -7,7 +7,7 @@ * - fulfillment_set * properties: * fulfillment_set: - * $ref: "#/components/schemas/FulfillmentSetResponse" + * $ref: "#/components/schemas/AdminFulfillmentSet" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetsDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminFulfillmentSetsDeleteResponse.ts deleted file mode 100644 index 699fc91879..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminFulfillmentSetsDeleteResponse.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @schema AdminFulfillmentSetsDeleteResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminFulfillmentSetsDeleteResponse - * required: - * - id - * - object - * - deleted - * properties: - * id: - * type: string - * title: id - * description: The fulfillment set's ID. - * object: - * type: string - * title: object - * description: The fulfillment set's object. - * deleted: - * type: boolean - * title: deleted - * description: The fulfillment set's deleted. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminGeoZone.ts b/www/utils/generated/oas-output/schemas/AdminGeoZone.ts new file mode 100644 index 0000000000..d74adea573 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminGeoZone.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminGeoZone + * type: object + * description: The geo zone's geo zones. + * x-schemaName: AdminGeoZone + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminGeoZoneResponse.ts b/www/utils/generated/oas-output/schemas/AdminGeoZoneResponse.ts deleted file mode 100644 index 153366c7c6..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminGeoZoneResponse.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema AdminGeoZoneResponse - * type: object - * description: The geo zone's geo zones. - * x-schemaName: AdminGeoZoneResponse - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts b/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts new file mode 100644 index 0000000000..58057e508a --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminGetUploadParams.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminGetUploadParams + * type: object + * description: SUMMARY + * x-schemaName: AdminGetUploadParams + * properties: + * fields: + * type: string + * title: fields + * description: The upload's fields. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts new file mode 100644 index 0000000000..e4b099eddd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderCancelFulfillment.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminOrderCancelFulfillment + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderCancelFulfillment + * properties: + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts new file mode 100644 index 0000000000..1206bef698 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderCreateFulfillment.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminOrderCreateFulfillment + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderCreateFulfillment + * required: + * - items + * - location_id + * - metadata + * properties: + * items: + * type: array + * description: The order's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * location_id: + * type: string + * title: location_id + * description: The order's location id. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts b/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts new file mode 100644 index 0000000000..4e7be782a1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderCreateShipment.ts @@ -0,0 +1,60 @@ +/** + * @schema AdminOrderCreateShipment + * type: object + * description: SUMMARY + * x-schemaName: AdminOrderCreateShipment + * required: + * - items + * - metadata + * properties: + * items: + * type: array + * description: The order's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * labels: + * type: array + * description: The order's labels. + * items: + * type: object + * description: The label's labels. + * required: + * - tracking_number + * - tracking_url + * - label_url + * properties: + * tracking_number: + * type: string + * title: tracking_number + * description: The label's tracking number. + * tracking_url: + * type: string + * title: tracking_url + * description: The label's tracking url. + * label_url: + * type: string + * title: label_url + * description: The label's label url. + * no_notification: + * type: boolean + * title: no_notification + * description: The order's no notification. + * metadata: + * type: object + * description: The order's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts new file mode 100644 index 0000000000..9a33e5eb20 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts @@ -0,0 +1,49 @@ +/** + * @schema AdminPostReceiveReturnsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReceiveReturnsReqSchema + * required: + * - return_id + * - items + * - internal_note + * properties: + * return_id: + * type: string + * title: return_id + * description: The return's return id. + * items: + * type: array + * description: The return's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * - reason_id + * - note + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * reason_id: + * type: string + * title: reason_id + * description: The item's reason id. + * note: + * type: string + * title: note + * description: The item's note. + * internal_note: + * type: string + * title: internal_note + * description: The return's internal note. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts new file mode 100644 index 0000000000..3a6509ad06 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts @@ -0,0 +1,77 @@ +/** + * @schema AdminPostReturnsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: AdminPostReturnsReqSchema + * required: + * - order_id + * - items + * - return_shipping + * - internal_note + * - location_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The return's order id. + * items: + * type: array + * description: The return's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * - reason_id + * - note + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * reason_id: + * type: string + * title: reason_id + * description: The item's reason id. + * note: + * type: string + * title: note + * description: The item's note. + * return_shipping: + * type: object + * description: The return's return shipping. + * required: + * - option_id + * properties: + * option_id: + * type: string + * title: option_id + * description: The return shipping's option id. + * price: + * type: number + * title: price + * description: The return shipping's price. + * internal_note: + * type: string + * title: internal_note + * description: The return's internal note. + * receive_now: + * type: boolean + * title: receive_now + * description: The return's receive now. + * refund_amount: + * type: number + * title: refund_amount + * description: The return's refund amount. + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPrice.ts b/www/utils/generated/oas-output/schemas/AdminPrice.ts new file mode 100644 index 0000000000..d72eb3c0df --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminPrice.ts @@ -0,0 +1,67 @@ +/** + * @schema AdminPrice + * type: object + * description: The price's prices. + * x-schemaName: AdminPrice + * required: + * - id + * - title + * - currency_code + * - amount + * - raw_amount + * - min_quantity + * - max_quantity + * - price_set_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The price's ID. + * title: + * type: string + * title: title + * description: The price's title. + * currency_code: + * type: string + * title: currency_code + * description: The price's currency code. + * amount: + * type: number + * title: amount + * description: The price's amount. + * raw_amount: + * type: object + * description: The price's raw amount. + * min_quantity: + * type: number + * title: min_quantity + * description: The price's min quantity. + * max_quantity: + * type: number + * title: max_quantity + * description: The price's max quantity. + * price_set_id: + * type: string + * title: price_set_id + * description: The price's price set id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The price's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The price's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The price's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminPriceSetPriceResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceSetPriceResponse.ts deleted file mode 100644 index 9d81118975..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminPriceSetPriceResponse.ts +++ /dev/null @@ -1,35 +0,0 @@ -/** - * @schema AdminPriceSetPriceResponse - * type: object - * description: The price's prices. - * x-schemaName: AdminPriceSetPriceResponse - * required: - * - id - * - amount - * - currency_code - * - created_at - * - updated_at - * properties: - * id: - * type: string - * title: id - * description: The price's ID. - * amount: - * type: number - * title: amount - * description: The price's amount. - * currency_code: - * type: string - * title: currency_code - * description: The price's currency code. - * created_at: - * type: string - * title: created_at - * description: The price's created at. - * updated_at: - * type: string - * title: updated_at - * description: The price's updated at. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts new file mode 100644 index 0000000000..99c9fd88b8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -0,0 +1,172 @@ +/** + * @schema AdminProduct + * type: object + * description: The product's parent. + * x-schemaName: AdminProduct + * required: + * - type + * - title + * - status + * - length + * - options + * - description + * - id + * - handle + * - hs_code + * - weight + * - height + * - width + * - origin_country + * - mid_code + * - material + * - thumbnail + * - created_at + * - updated_at + * - deleted_at + * - subtitle + * - is_giftcard + * - collection_id + * - type_id + * - tags + * - images + * - discountable + * - external_id + * properties: + * collection: + * $ref: "#/components/schemas/AdminCollection" + * categories: + * type: array + * description: The parent's categories. + * items: + * $ref: "#/components/schemas/AdminProductCategory" + * sales_channels: + * type: array + * description: The parent's sales channels. + * items: + * $ref: "#/components/schemas/AdminSalesChannel" + * variants: + * type: array + * description: The parent's variants. + * items: + * $ref: "#/components/schemas/AdminProductVariant" + * type: + * $ref: "#/components/schemas/AdminProduct" + * title: + * type: string + * title: title + * description: The parent's title. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * length: + * type: number + * title: length + * description: The parent's length. + * options: + * type: array + * description: The parent's options. + * items: + * $ref: "#/components/schemas/BaseProductOption" + * description: + * type: string + * title: description + * description: The parent's description. + * id: + * type: string + * title: id + * description: The parent's ID. + * handle: + * type: string + * title: handle + * description: The parent's handle. + * metadata: + * type: object + * description: The parent's metadata. + * hs_code: + * type: string + * title: hs_code + * description: The parent's hs code. + * weight: + * type: number + * title: weight + * description: The parent's weight. + * height: + * type: number + * title: height + * description: The parent's height. + * width: + * type: number + * title: width + * description: The parent's width. + * origin_country: + * type: string + * title: origin_country + * description: The parent's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The parent's mid code. + * material: + * type: string + * title: material + * description: The parent's material. + * thumbnail: + * type: string + * title: thumbnail + * description: The parent's thumbnail. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The parent's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The parent's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The parent's deleted at. + * subtitle: + * type: string + * title: subtitle + * description: The parent's subtitle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The parent's is giftcard. + * collection_id: + * type: string + * title: collection_id + * description: The parent's collection id. + * type_id: + * type: string + * title: type_id + * description: The parent's type id. + * tags: + * type: array + * description: The parent's tags. + * items: + * $ref: "#/components/schemas/BaseProductTag" + * images: + * type: array + * description: The parent's images. + * items: + * $ref: "#/components/schemas/BaseProductImage" + * discountable: + * type: boolean + * title: discountable + * description: The parent's discountable. + * external_id: + * type: string + * title: external_id + * description: The parent's external id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategory.ts b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts new file mode 100644 index 0000000000..14ab051148 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductCategory.ts @@ -0,0 +1,82 @@ +/** + * @schema AdminProductCategory + * type: object + * description: The category's categories. + * x-schemaName: AdminProductCategory + * required: + * - category_children + * - parent_category + * - name + * - description + * - id + * - handle + * - created_at + * - updated_at + * - deleted_at + * - parent_category_id + * - is_internal + * - is_active + * - rank + * properties: + * category_children: + * type: array + * description: The category's category children. + * items: + * $ref: "#/components/schemas/AdminProductCategory" + * parent_category: + * $ref: "#/components/schemas/AdminProductCategory" + * products: + * type: array + * description: The category's products. + * items: + * $ref: "#/components/schemas/AdminProduct" + * name: + * type: string + * title: name + * description: The category's name. + * description: + * type: string + * title: description + * description: The category's description. + * id: + * type: string + * title: id + * description: The category's ID. + * handle: + * type: string + * title: handle + * description: The category's handle. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The category's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The category's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The category's deleted at. + * parent_category_id: + * type: string + * title: parent_category_id + * description: The category's parent category id. + * is_internal: + * type: boolean + * title: is_internal + * description: The category's is internal. + * is_active: + * type: boolean + * title: is_active + * description: The category's is active. + * rank: + * type: number + * title: rank + * description: The category's rank. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategoryListResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductCategoryListResponse.ts index 56ff20c335..e0ea4b7c79 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategoryListResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategoryListResponse.ts @@ -4,16 +4,11 @@ * description: SUMMARY * x-schemaName: AdminProductCategoryListResponse * required: - * - product_categories * - limit * - offset * - count + * - product_categories * properties: - * product_categories: - * type: array - * description: The product category's product categories. - * items: - * $ref: "#/components/schemas/ProductCategoryResponse" * limit: * type: number * title: limit @@ -26,6 +21,11 @@ * type: number * title: count * description: The product category's count. + * product_categories: + * type: array + * description: The product category's product categories. + * items: + * $ref: "#/components/schemas/AdminProductCategory" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductCategoryResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductCategoryResponse.ts index 7fb72973d9..b2cca5f0a1 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductCategoryResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductCategoryResponse.ts @@ -7,7 +7,7 @@ * - product_category * properties: * product_category: - * $ref: "#/components/schemas/ProductCategoryResponse" + * $ref: "#/components/schemas/AdminProductCategory" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts new file mode 100644 index 0000000000..78dddd9dec --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductDeleteResponse.ts @@ -0,0 +1,29 @@ +/** + * @schema AdminProductDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * object: + * type: string + * title: object + * description: The product's object. + * default: product + * deleted: + * type: boolean + * title: deleted + * description: The product's deleted. + * parent: + * type: object + * description: The product's parent. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductOption.ts b/www/utils/generated/oas-output/schemas/AdminProductOption.ts new file mode 100644 index 0000000000..b4977d464d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductOption.ts @@ -0,0 +1,49 @@ +/** + * @schema AdminProductOption + * type: object + * description: The product's product option. + * x-schemaName: AdminProductOption + * required: + * - id + * - title + * properties: + * id: + * type: string + * title: id + * description: The product option's ID. + * title: + * type: string + * title: title + * description: The product option's title. + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The product option's product id. + * values: + * type: array + * description: The product option's values. + * items: + * $ref: "#/components/schemas/BaseProductOptionValue" + * metadata: + * type: object + * description: The product option's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product option's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product option's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product option's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts new file mode 100644 index 0000000000..8a49d3ce8f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts @@ -0,0 +1,28 @@ +/** + * @schema AdminProductOptionDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductOptionDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * object: + * type: string + * title: object + * description: The product's object. + * default: product_option + * deleted: + * type: boolean + * title: deleted + * description: The product's deleted. + * parent: + * $ref: "#/components/schemas/AdminProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionResponse.ts new file mode 100644 index 0000000000..30f607f8f8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminProductOptionResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductOptionResponse + * required: + * - product_option + * properties: + * product_option: + * $ref: "#/components/schemas/AdminProductOption" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductResponse.ts new file mode 100644 index 0000000000..383b385742 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminProductResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductResponse + * required: + * - product + * properties: + * product: + * $ref: "#/components/schemas/AdminProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts new file mode 100644 index 0000000000..1e9c9210e5 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -0,0 +1,133 @@ +/** + * @schema AdminProductVariant + * type: object + * description: The updated's details. + * x-schemaName: AdminProductVariant + * required: + * - prices + * - id + * - title + * - sku + * - barcode + * - ean + * - upc + * - allow_backorder + * - manage_inventory + * - hs_code + * - origin_country + * - mid_code + * - material + * - weight + * - length + * - height + * - width + * - options + * - created_at + * - updated_at + * - deleted_at + * properties: + * prices: + * type: array + * description: The updated's prices. + * items: + * $ref: "#/components/schemas/AdminPrice" + * id: + * type: string + * title: id + * description: The updated's ID. + * title: + * type: string + * title: title + * description: The updated's title. + * sku: + * type: string + * title: sku + * description: The updated's sku. + * barcode: + * type: string + * title: barcode + * description: The updated's barcode. + * ean: + * type: string + * title: ean + * description: The updated's ean. + * upc: + * type: string + * title: upc + * description: The updated's upc. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The updated's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The updated's manage inventory. + * hs_code: + * type: string + * title: hs_code + * description: The updated's hs code. + * origin_country: + * type: string + * title: origin_country + * description: The updated's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The updated's mid code. + * material: + * type: string + * title: material + * description: The updated's material. + * weight: + * type: number + * title: weight + * description: The updated's weight. + * length: + * type: number + * title: length + * description: The updated's length. + * height: + * type: number + * title: height + * description: The updated's height. + * width: + * type: number + * title: width + * description: The updated's width. + * options: + * type: array + * description: The updated's options. + * items: + * $ref: "#/components/schemas/BaseProductOptionValue" + * product: + * $ref: "#/components/schemas/BaseProduct" + * product_id: + * type: string + * title: product_id + * description: The updated's product id. + * variant_rank: + * type: number + * title: variant_rank + * description: The updated's variant rank. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The updated's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The updated's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The updated's deleted at. + * metadata: + * type: object + * description: The updated's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts new file mode 100644 index 0000000000..478ef4365e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts @@ -0,0 +1,28 @@ +/** + * @schema AdminProductVariantDeleteResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductVariantDeleteResponse + * required: + * - id + * - object + * - deleted + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * object: + * type: string + * title: object + * description: The product's object. + * default: variant + * deleted: + * type: boolean + * title: deleted + * description: The product's deleted. + * parent: + * $ref: "#/components/schemas/AdminProduct" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts new file mode 100644 index 0000000000..4d28c1d1dd --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantParams.ts @@ -0,0 +1,281 @@ +/** + * @schema AdminProductVariantParams + * type: object + * description: The product's variants. + * x-schemaName: AdminProductVariantParams + * properties: + * q: + * type: string + * title: q + * description: The variant's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The variant's ID. + * - type: array + * description: The variant's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * sku: + * oneOf: + * - type: string + * title: sku + * description: The variant's sku. + * - type: array + * description: The variant's sku. + * items: + * type: string + * title: sku + * description: The sku's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The variant's product id. + * - type: array + * description: The variant's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * options: + * type: object + * description: The variant's options. + * limit: + * type: number + * title: limit + * description: The variant's limit. + * offset: + * type: number + * title: offset + * description: The variant's offset. + * order: + * type: string + * title: order + * description: The variant's order. + * fields: + * type: string + * title: fields + * description: The variant's fields. + * $and: + * type: array + * description: The variant's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductVariantParams + * properties: + * q: + * type: string + * title: q + * description: The $and's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $and's ID. + * - type: array + * description: The $and's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * sku: + * oneOf: + * - type: string + * title: sku + * description: The $and's sku. + * - type: array + * description: The $and's sku. + * items: + * type: string + * title: sku + * description: The sku's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $and's product id. + * - type: array + * description: The $and's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * options: + * type: object + * description: The $and's options. + * limit: + * type: number + * title: limit + * description: The $and's limit. + * offset: + * type: number + * title: offset + * description: The $and's offset. + * order: + * type: string + * title: order + * description: The $and's order. + * fields: + * type: string + * title: fields + * description: The $and's fields. + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $and's details. + * properties: + * $and: + * type: array + * description: The $and's details. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $and's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $or's details. + * $or: + * type: array + * description: The variant's $or. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductVariantParams + * properties: + * q: + * type: string + * title: q + * description: The $or's q. + * id: + * oneOf: + * - type: string + * title: id + * description: The $or's ID. + * - type: array + * description: The $or's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * sku: + * oneOf: + * - type: string + * title: sku + * description: The $or's sku. + * - type: array + * description: The $or's sku. + * items: + * type: string + * title: sku + * description: The sku's details. + * product_id: + * oneOf: + * - type: string + * title: product_id + * description: The $or's product id. + * - type: array + * description: The $or's product id. + * items: + * type: string + * title: product_id + * description: The product id's details. + * options: + * type: object + * description: The $or's options. + * limit: + * type: number + * title: limit + * description: The $or's limit. + * offset: + * type: number + * title: offset + * description: The $or's offset. + * order: + * type: string + * title: order + * description: The $or's order. + * fields: + * type: string + * title: fields + * description: The $or's fields. + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $or's details. + * - type: object + * description: The $or's details. + * properties: + * $and: + * type: array + * description: The $or's $and. + * items: + * oneOf: + * - type: object + * description: The $and's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $and's details. + * $or: + * type: array + * description: The $or's details. + * items: + * oneOf: + * - type: object + * description: The $or's details. + * x-schemaName: BaseProductVariantParams + * - type: object + * description: The $or's details. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantResponse.ts new file mode 100644 index 0000000000..00ae3b9730 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantResponse.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminProductVariantResponse + * type: object + * description: SUMMARY + * x-schemaName: AdminProductVariantResponse + * required: + * - variant + * properties: + * variant: + * $ref: "#/components/schemas/AdminProductVariant" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminRevokeApiKey.ts b/www/utils/generated/oas-output/schemas/AdminRevokeApiKey.ts new file mode 100644 index 0000000000..cba367f0d8 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminRevokeApiKey.ts @@ -0,0 +1,13 @@ +/** + * @schema AdminRevokeApiKey + * type: object + * description: SUMMARY + * x-schemaName: AdminRevokeApiKey + * properties: + * revoke_in: + * type: number + * title: revoke_in + * description: The api key's revoke in. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts new file mode 100644 index 0000000000..ddae7a3a2c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminSalesChannel.ts @@ -0,0 +1,52 @@ +/** + * @schema AdminSalesChannel + * type: object + * description: The sales channel's sales channels. + * x-schemaName: AdminSalesChannel + * required: + * - id + * - name + * - description + * - is_disabled + * - metadata + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * name: + * type: string + * title: name + * description: The sales channel's name. + * description: + * type: string + * title: description + * description: The sales channel's description. + * is_disabled: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * metadata: + * type: object + * description: The sales channel's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The sales channel's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The sales channel's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The sales channel's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/ServiceZoneResponse.ts b/www/utils/generated/oas-output/schemas/AdminServiceZone.ts similarity index 65% rename from www/utils/generated/oas-output/schemas/ServiceZoneResponse.ts rename to www/utils/generated/oas-output/schemas/AdminServiceZone.ts index e95aee6f5f..e92883d568 100644 --- a/www/utils/generated/oas-output/schemas/ServiceZoneResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminServiceZone.ts @@ -1,13 +1,14 @@ /** - * @schema ServiceZoneResponse + * @schema AdminServiceZone * type: object * description: The service zone's service zones. - * x-schemaName: ServiceZoneResponse + * x-schemaName: AdminServiceZone * required: * - id * - name - * - metadata + * - fulfillment_set_id * - geo_zones + * - shipping_options * - created_at * - updated_at * - deleted_at @@ -20,30 +21,35 @@ * type: string * title: name * description: The service zone's name. - * metadata: - * type: object - * description: The service zone's metadata. - * properties: {} + * fulfillment_set_id: + * type: string + * title: fulfillment_set_id + * description: The service zone's fulfillment set id. * geo_zones: * type: array * description: The service zone's geo zones. * items: - * $ref: "#/components/schemas/AdminGeoZoneResponse" + * $ref: "#/components/schemas/AdminGeoZone" + * shipping_options: + * type: array + * description: The service zone's shipping options. + * items: + * $ref: "#/components/schemas/AdminShippingOption" * created_at: * type: string + * format: date-time * title: created_at * description: The service zone's created at. - * format: date-time * updated_at: * type: string + * format: date-time * title: updated_at * description: The service zone's updated at. - * format: date-time * deleted_at: * type: string + * format: date-time * title: deleted_at * description: The service zone's deleted at. - * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZoneResponse.ts b/www/utils/generated/oas-output/schemas/AdminServiceZoneResponse.ts index 85a3d07572..8f9c985594 100644 --- a/www/utils/generated/oas-output/schemas/AdminServiceZoneResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminServiceZoneResponse.ts @@ -7,7 +7,7 @@ * - service_zone * properties: * service_zone: - * $ref: "#/components/schemas/ServiceZoneResponse" + * $ref: "#/components/schemas/AdminServiceZone" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts new file mode 100644 index 0000000000..26b88fbfc2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminShippingOption + * type: object + * description: The shipping option's shipping options. + * x-schemaName: AdminShippingOption + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts index 4353f0e92d..ab33eda9b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionDeleteResponse.ts @@ -16,10 +16,14 @@ * type: string * title: object * description: The shipping option's object. + * default: shipping_option * deleted: * type: boolean * title: deleted * description: The shipping option's deleted. + * parent: + * type: object + * description: The shipping option's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionListResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionListResponse.ts deleted file mode 100644 index a0469f487c..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionListResponse.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * @schema AdminShippingOptionListResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminShippingOptionListResponse - * required: - * - shipping_options - * - limit - * - offset - * - count - * properties: - * shipping_options: - * type: array - * description: The shipping option's shipping options. - * items: - * $ref: "#/components/schemas/AdminShippingOptionResponse" - * limit: - * type: number - * title: limit - * description: The shipping option's limit. - * offset: - * type: number - * title: offset - * description: The shipping option's offset. - * count: - * type: number - * title: count - * description: The shipping option's count. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionResponse.ts index 9983e881a2..705bedd4d6 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionResponse.ts @@ -1,98 +1,13 @@ /** * @schema AdminShippingOptionResponse * type: object - * description: The shipping option's details. + * description: SUMMARY * x-schemaName: AdminShippingOptionResponse * required: - * - id - * - name - * - price_type - * - service_zone_id - * - shipping_profile_id - * - provider_id - * - shipping_option_type_id - * - data - * - metadata - * - service_zone - * - shipping_profile - * - provider - * - type - * - rules - * - prices - * - created_at - * - updated_at - * - deleted_at + * - shipping_option * properties: - * id: - * type: string - * title: id - * description: The shipping option's ID. - * name: - * type: string - * title: name - * description: The shipping option's name. - * price_type: - * type: string - * enum: - * - flat - * - calculated - * 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. - * provider_id: - * type: string - * title: provider_id - * description: The shipping option's provider id. - * shipping_option_type_id: - * type: string - * title: shipping_option_type_id - * description: The shipping option's shipping option type id. - * data: - * type: object - * description: The shipping option's data. - * properties: {} - * metadata: - * type: object - * description: The shipping option's metadata. - * properties: {} - * service_zone: - * $ref: "#/components/schemas/AdminServiceZoneResponse" - * shipping_profile: - * $ref: "#/components/schemas/AdminShippingProfileResponse" - * provider: - * $ref: "#/components/schemas/AdminFulfillmentProviderResponse" - * type: - * $ref: "#/components/schemas/AdminShippingOptionTypeResponse" - * rules: - * type: array - * description: The shipping option's rules. - * items: - * $ref: "#/components/schemas/AdminShippingOptionRuleResponse" - * prices: - * type: array - * description: The shipping option's prices. - * items: - * $ref: "#/components/schemas/AdminPriceSetPriceResponse" - * created_at: - * type: string - * title: created_at - * description: The shipping option's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The shipping option's updated at. - * format: date-time - * deleted_at: - * type: string - * title: deleted_at - * description: The shipping option's deleted at. - * format: date-time + * shipping_option: + * $ref: "#/components/schemas/AdminShippingOption" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionRetrieveResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionRetrieveResponse.ts deleted file mode 100644 index 179ad62ac4..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionRetrieveResponse.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema AdminShippingOptionRetrieveResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminShippingOptionRetrieveResponse - * required: - * - shipping_option - * properties: - * shipping_option: - * $ref: "#/components/schemas/AdminShippingOptionResponse" - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionRuleResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionRuleResponse.ts deleted file mode 100644 index 21b20acf87..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionRuleResponse.ts +++ /dev/null @@ -1,53 +0,0 @@ -/** - * @schema AdminShippingOptionRuleResponse - * type: object - * description: The rule's rules. - * x-schemaName: AdminShippingOptionRuleResponse - * required: - * - id - * - attribute - * - operator - * - value - * - shipping_option_id - * - created_at - * - updated_at - * - deleted_at - * properties: - * id: - * type: string - * title: id - * description: The rule's ID. - * attribute: - * type: string - * title: attribute - * description: The rule's attribute. - * operator: - * type: string - * title: operator - * description: The rule's operator. - * value: - * type: object - * description: The rule's value. - * properties: {} - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The rule's shipping option id. - * created_at: - * type: string - * title: created_at - * description: The rule's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The rule's updated at. - * format: date-time - * deleted_at: - * type: string - * title: deleted_at - * description: The rule's deleted at. - * format: date-time - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionTypeResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionTypeResponse.ts deleted file mode 100644 index 5c246fdf1a..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminShippingOptionTypeResponse.ts +++ /dev/null @@ -1,53 +0,0 @@ -/** - * @schema AdminShippingOptionTypeResponse - * type: object - * description: The shipping option's type. - * x-schemaName: AdminShippingOptionTypeResponse - * required: - * - id - * - label - * - description - * - code - * - shipping_option_id - * - created_at - * - updated_at - * - deleted_at - * properties: - * id: - * type: string - * title: id - * description: The type's ID. - * 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. - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The type's shipping option id. - * created_at: - * type: string - * title: created_at - * description: The type's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The type's updated at. - * format: date-time - * deleted_at: - * type: string - * title: deleted_at - * description: The type's deleted at. - * format: date-time - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts new file mode 100644 index 0000000000..ae81604efa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfile.ts @@ -0,0 +1,8 @@ +/** + * @schema AdminShippingProfile + * type: object + * description: The shipping option's shipping profile. + * x-schemaName: AdminShippingProfile + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts index 84f0099f01..7cc02e7b9a 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfileDeleteResponse.ts @@ -16,10 +16,14 @@ * type: string * title: object * description: The shipping profile's object. + * default: shipping_profile * deleted: * type: boolean * title: deleted * description: The shipping profile's deleted. + * parent: + * type: object + * description: The shipping profile's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfileResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfileResponse.ts index 7d6c2377b4..f5981cc31d 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfileResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingProfileResponse.ts @@ -7,7 +7,7 @@ * - shipping_profile * properties: * shipping_profile: - * $ref: "#/components/schemas/ShippingProfileResponse" + * $ref: "#/components/schemas/AdminShippingProfile" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminShippingProfilesResponse.ts b/www/utils/generated/oas-output/schemas/AdminShippingProfilesResponse.ts deleted file mode 100644 index 45c009955d..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminShippingProfilesResponse.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * @schema AdminShippingProfilesResponse - * type: object - * description: SUMMARY - * x-schemaName: AdminShippingProfilesResponse - * required: - * - shipping_profiles - * - limit - * - offset - * - count - * properties: - * shipping_profiles: - * type: array - * description: The shipping profile's shipping profiles. - * items: - * $ref: "#/components/schemas/ShippingProfileResponse" - * limit: - * type: number - * title: limit - * description: The shipping profile's limit. - * offset: - * type: number - * title: offset - * description: The shipping profile's offset. - * count: - * type: number - * title: count - * description: The shipping profile's count. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateApiKey.ts b/www/utils/generated/oas-output/schemas/AdminUpdateApiKey.ts new file mode 100644 index 0000000000..ea2a0388a7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateApiKey.ts @@ -0,0 +1,15 @@ +/** + * @schema AdminUpdateApiKey + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateApiKey + * required: + * - title + * properties: + * title: + * type: string + * title: title + * description: The api key's title. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CreateCampaign.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts similarity index 75% rename from www/utils/generated/oas-output/schemas/CreateCampaign.ts rename to www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts index cc0aea7560..d967b32017 100644 --- a/www/utils/generated/oas-output/schemas/CreateCampaign.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCampaign.ts @@ -1,11 +1,10 @@ /** - * @schema CreateCampaign + * @schema AdminUpdateCampaign * type: object - * description: The promotion's campaign. - * x-schemaName: CreateCampaign + * description: SUMMARY + * x-schemaName: AdminUpdateCampaign * required: - * - name - * - campaign_identifier + * - description * - starts_at * - ends_at * properties: @@ -13,18 +12,22 @@ * type: string * title: name * description: The campaign's name. - * description: - * type: string - * title: description - * description: The campaign's description. - * currency: - * type: string - * title: currency - * description: The campaign's currency. * campaign_identifier: * type: string * title: campaign_identifier * description: The campaign's campaign identifier. + * description: + * type: string + * title: description + * description: The campaign's description. + * budget: + * type: object + * description: The campaign's budget. + * properties: + * limit: + * type: number + * title: limit + * description: The budget's limit. * starts_at: * type: string * title: starts_at @@ -35,15 +38,12 @@ * title: ends_at * description: The campaign's ends at. * format: date-time - * budget: - * $ref: "#/components/schemas/CreateCampaignBudget" * promotions: * type: array * description: The campaign's promotions. * items: * type: object * description: The promotion's promotions. - * x-schemaName: Promotion * required: * - id * properties: diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts new file mode 100644 index 0000000000..acf7754a64 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts @@ -0,0 +1,22 @@ +/** + * @schema AdminUpdateCollection + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateCollection + * required: + * - metadata + * properties: + * title: + * type: string + * title: title + * description: The collection's title. + * handle: + * type: string + * title: handle + * description: The collection's handle. + * metadata: + * type: object + * description: The collection's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts new file mode 100644 index 0000000000..e2bd3514e2 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCustomer.ts @@ -0,0 +1,40 @@ +/** + * @schema AdminUpdateCustomer + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateCustomer + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * - metadata + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * metadata: + * type: object + * description: The customer's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts new file mode 100644 index 0000000000..8acba87eab --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts @@ -0,0 +1,19 @@ +/** + * @schema AdminUpdateCustomerGroup + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateCustomerGroup + * required: + * - name + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The customer group's name. + * metadata: + * type: object + * description: The customer group's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts new file mode 100644 index 0000000000..e5fc45c66c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts @@ -0,0 +1,42 @@ +/** + * @schema AdminUpdatePriceList + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdatePriceList + * required: + * - description + * - starts_at + * - ends_at + * properties: + * title: + * type: string + * title: title + * description: The price list's title. + * description: + * type: string + * title: description + * description: The price list's description. + * starts_at: + * type: string + * title: starts_at + * description: The price list's starts at. + * ends_at: + * type: string + * title: ends_at + * description: The price list's ends at. + * status: + * type: string + * enum: + * - active + * - draft + * type: + * type: string + * enum: + * - sale + * - override + * rules: + * type: object + * description: The price list's rules. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts new file mode 100644 index 0000000000..a84078f2ad --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProduct.ts @@ -0,0 +1,151 @@ +/** + * @schema AdminUpdateProduct + * type: object + * description: The update's details. + * x-schemaName: AdminUpdateProduct + * properties: + * title: + * type: string + * title: title + * description: The update's title. + * subtitle: + * type: string + * title: subtitle + * description: The update's subtitle. + * description: + * type: string + * title: description + * description: The update's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The update's is giftcard. + * discountable: + * type: boolean + * title: discountable + * description: The update's discountable. + * images: + * type: array + * description: The update's images. + * items: + * type: object + * description: The image's images. + * required: + * - url + * properties: + * url: + * type: string + * title: url + * description: The image's url. + * thumbnail: + * type: string + * title: thumbnail + * description: The update's thumbnail. + * handle: + * type: string + * title: handle + * description: The update's handle. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * type_id: + * type: string + * title: type_id + * description: The update's type id. + * collection_id: + * type: string + * title: collection_id + * description: The update's collection id. + * categories: + * type: array + * description: The update's categories. + * items: + * type: object + * description: The category's categories. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The category's ID. + * tags: + * type: array + * description: The update's tags. + * items: + * type: object + * description: The tag's tags. + * properties: + * id: + * type: string + * title: id + * description: The tag's ID. + * value: + * type: string + * title: value + * description: The tag's value. + * options: + * type: array + * description: The update's options. + * items: + * $ref: "#/components/schemas/AdminUpdateProductOption" + * variants: + * type: array + * description: The update's variants. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariant" + * sales_channels: + * type: array + * description: The update's sales channels. + * items: + * type: object + * description: The sales channel's sales channels. + * required: + * - id + * properties: + * id: + * type: string + * title: id + * description: The sales channel's ID. + * weight: + * type: number + * title: weight + * description: The update's weight. + * length: + * type: number + * title: length + * description: The update's length. + * height: + * type: number + * title: height + * description: The update's height. + * width: + * type: number + * title: width + * description: The update's width. + * hs_code: + * type: string + * title: hs_code + * description: The update's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The update's mid code. + * origin_country: + * type: string + * title: origin_country + * description: The update's origin country. + * material: + * type: string + * title: material + * description: The update's material. + * metadata: + * type: object + * description: The update's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductOption.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductOption.ts new file mode 100644 index 0000000000..eff949c82d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductOption.ts @@ -0,0 +1,20 @@ +/** + * @schema AdminUpdateProductOption + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateProductOption + * properties: + * title: + * type: string + * title: title + * description: The product's title. + * values: + * type: array + * description: The product's values. + * items: + * type: string + * title: values + * description: The value's values. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts new file mode 100644 index 0000000000..1e551e540c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateProductVariant.ts @@ -0,0 +1,84 @@ +/** + * @schema AdminUpdateProductVariant + * type: object + * description: The update's details. + * x-schemaName: AdminUpdateProductVariant + * properties: + * title: + * type: string + * title: title + * description: The update's title. + * sku: + * type: string + * title: sku + * description: The update's sku. + * ean: + * type: string + * title: ean + * description: The update's ean. + * upc: + * type: string + * title: upc + * description: The update's upc. + * barcode: + * type: string + * title: barcode + * description: The update's barcode. + * hs_code: + * type: string + * title: hs_code + * description: The update's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The update's mid code. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: The update's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The update's manage inventory. + * variant_rank: + * type: number + * title: variant_rank + * description: The update's variant rank. + * weight: + * type: number + * title: weight + * description: The update's weight. + * length: + * type: number + * title: length + * description: The update's length. + * height: + * type: number + * title: height + * description: The update's height. + * width: + * type: number + * title: width + * description: The update's width. + * origin_country: + * type: string + * title: origin_country + * description: The update's origin country. + * material: + * type: string + * title: material + * description: The update's material. + * metadata: + * type: object + * description: The update's metadata. + * prices: + * type: array + * description: The update's prices. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantPrice" + * options: + * type: object + * description: The update's options. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts new file mode 100644 index 0000000000..4ed0e0812b --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts @@ -0,0 +1,27 @@ +/** + * @schema AdminUpdateSalesChannel + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateSalesChannel + * required: + * - description + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The sales channel's name. + * description: + * type: string + * title: description + * description: The sales channel's description. + * is_disabled: + * type: boolean + * title: is_disabled + * description: The sales channel's is disabled. + * metadata: + * type: object + * description: The sales channel's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts new file mode 100644 index 0000000000..5e08691535 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts @@ -0,0 +1,68 @@ +/** + * @schema AdminUpdateStockLocation + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateStockLocation + * required: + * - address_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The stock location's name. + * address: + * type: object + * description: The stock location's address. + * required: + * - address_1 + * - address_2 + * - company + * - city + * - country_code + * - phone + * - postal_code + * - province + * properties: + * address_1: + * type: string + * title: address_1 + * description: The address's address 1. + * address_2: + * type: string + * title: address_2 + * description: The address's address 2. + * company: + * type: string + * title: company + * description: The address's company. + * city: + * type: string + * title: city + * description: The address's city. + * country_code: + * type: string + * title: country_code + * description: The address's country code. + * phone: + * type: string + * title: phone + * description: The address's phone. + * postal_code: + * type: string + * title: postal_code + * description: The address's postal code. + * province: + * type: string + * title: province + * description: The address's province. + * address_id: + * type: string + * title: address_id + * description: The stock location's address id. + * metadata: + * type: object + * description: The stock location's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts new file mode 100644 index 0000000000..cbd71cc62d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts @@ -0,0 +1,51 @@ +/** + * @schema AdminUpdateStore + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateStore + * required: + * - name + * - default_sales_channel_id + * - default_region_id + * - default_location_id + * - metadata + * properties: + * name: + * type: string + * title: name + * description: The store's name. + * supported_currencies: + * type: array + * description: The store's supported currencies. + * items: + * type: object + * description: The supported currency's supported currencies. + * required: + * - currency_code + * properties: + * currency_code: + * type: string + * title: currency_code + * description: The supported currency's currency code. + * is_default: + * type: boolean + * title: is_default + * description: The supported currency's is default. + * default_sales_channel_id: + * type: string + * title: default_sales_channel_id + * description: The store's default sales channel id. + * default_region_id: + * type: string + * title: default_region_id + * description: The store's default region id. + * default_location_id: + * type: string + * title: default_location_id + * description: The store's default location id. + * metadata: + * type: object + * description: The store's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts new file mode 100644 index 0000000000..1cdb48ce4c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts @@ -0,0 +1,52 @@ +/** + * @schema AdminUpdateTaxRate + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateTaxRate + * required: + * - metadata + * properties: + * rate: + * type: number + * title: rate + * description: The tax rate's rate. + * code: + * type: string + * title: code + * description: The tax rate's code. + * rules: + * type: array + * description: The tax rate's rules. + * items: + * type: object + * description: The rule's rules. + * required: + * - reference + * - reference_id + * properties: + * reference: + * type: string + * title: reference + * description: The rule's reference. + * reference_id: + * type: string + * title: reference_id + * description: The rule's reference id. + * name: + * type: string + * title: name + * description: The tax rate's name. + * is_default: + * type: boolean + * title: is_default + * description: The tax rate's is default. + * is_combinable: + * type: boolean + * title: is_combinable + * description: The tax rate's is combinable. + * metadata: + * type: object + * description: The tax rate's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts new file mode 100644 index 0000000000..bb12d598cf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminUpdateUser + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateUser + * required: + * - first_name + * - last_name + * - avatar_url + * properties: + * first_name: + * type: string + * title: first_name + * description: The user's first name. + * last_name: + * type: string + * title: last_name + * description: The user's last name. + * avatar_url: + * type: string + * title: avatar_url + * description: The user's avatar url. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts new file mode 100644 index 0000000000..8051d6af75 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts @@ -0,0 +1,15 @@ +/** + * @schema AdminUpdateVariantInventoryItem + * type: object + * description: SUMMARY + * x-schemaName: AdminUpdateVariantInventoryItem + * required: + * - required_quantity + * properties: + * required_quantity: + * type: number + * title: required_quantity + * description: The product's required quantity. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/ApplicationMethod.ts b/www/utils/generated/oas-output/schemas/ApplicationMethod.ts deleted file mode 100644 index 5bdde14261..0000000000 --- a/www/utils/generated/oas-output/schemas/ApplicationMethod.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema ApplicationMethod - * type: object - * description: The promotion's application method. - * x-schemaName: ApplicationMethod - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseCollection.ts b/www/utils/generated/oas-output/schemas/BaseCollection.ts new file mode 100644 index 0000000000..db44371321 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCollection.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseCollection + * type: object + * description: The product's collection. + * x-schemaName: BaseCollection + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCustomer.ts b/www/utils/generated/oas-output/schemas/BaseCustomer.ts new file mode 100644 index 0000000000..6e4892a837 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseCustomer.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseCustomer + * type: object + * description: The customer's customers. + * x-schemaName: BaseCustomer + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CustomerAddressResponse.ts b/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts similarity index 95% rename from www/utils/generated/oas-output/schemas/CustomerAddressResponse.ts rename to www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts index 3ffbafe07a..be689289cf 100644 --- a/www/utils/generated/oas-output/schemas/CustomerAddressResponse.ts +++ b/www/utils/generated/oas-output/schemas/BaseCustomerAddress.ts @@ -1,8 +1,8 @@ /** - * @schema CustomerAddressResponse + * @schema BaseCustomerAddress * type: object * description: The address's addresses. - * x-schemaName: CustomerAddressResponse + * x-schemaName: BaseCustomerAddress * required: * - id * - address_name @@ -86,13 +86,14 @@ * metadata: * type: object * description: The address's metadata. - * properties: {} * created_at: * type: string + * format: date-time * title: created_at * description: The address's created at. * updated_at: * type: string + * format: date-time * title: updated_at * description: The address's updated at. * diff --git a/www/utils/generated/oas-output/schemas/BaseProduct.ts b/www/utils/generated/oas-output/schemas/BaseProduct.ts new file mode 100644 index 0000000000..37ff243598 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProduct.ts @@ -0,0 +1,167 @@ +/** + * @schema BaseProduct + * type: object + * description: The updated's product. + * x-schemaName: BaseProduct + * required: + * - id + * - title + * - handle + * - subtitle + * - description + * - is_giftcard + * - status + * - thumbnail + * - width + * - weight + * - length + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - tags + * - variants + * - options + * - images + * - discountable + * - external_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * title: + * type: string + * title: title + * description: The product's title. + * handle: + * type: string + * title: handle + * description: The product's handle. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection: + * $ref: "#/components/schemas/BaseCollection" + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * $ref: "#/components/schemas/BaseProductCategory" + * type: + * $ref: "#/components/schemas/BaseProduct" + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * tags: + * type: array + * description: The product's tags. + * items: + * $ref: "#/components/schemas/BaseProductTag" + * variants: + * type: array + * description: The product's variants. + * items: + * $ref: "#/components/schemas/BaseProductVariant" + * options: + * type: array + * description: The product's options. + * items: + * $ref: "#/components/schemas/BaseProductOption" + * images: + * type: array + * description: The product's images. + * items: + * $ref: "#/components/schemas/BaseProductImage" + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * metadata: + * type: object + * description: The product's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductCategory.ts b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts new file mode 100644 index 0000000000..b856b0ea55 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseProductCategory + * type: object + * description: The category's categories. + * x-schemaName: BaseProductCategory + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductImage.ts b/www/utils/generated/oas-output/schemas/BaseProductImage.ts new file mode 100644 index 0000000000..ed0bb18675 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductImage.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseProductImage + * type: object + * description: The image's images. + * x-schemaName: BaseProductImage + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductOption.ts b/www/utils/generated/oas-output/schemas/BaseProductOption.ts new file mode 100644 index 0000000000..ad2d3af272 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductOption.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseProductOption + * type: object + * description: The option's options. + * x-schemaName: BaseProductOption + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts new file mode 100644 index 0000000000..bc93aad247 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductOptionValue.ts @@ -0,0 +1,44 @@ +/** + * @schema BaseProductOptionValue + * type: object + * description: The option's options. + * x-schemaName: BaseProductOptionValue + * required: + * - id + * - value + * properties: + * id: + * type: string + * title: id + * description: The option's ID. + * value: + * type: string + * title: value + * description: The option's value. + * option: + * $ref: "#/components/schemas/BaseProductOption" + * option_id: + * type: string + * title: option_id + * description: The option's option id. + * metadata: + * type: object + * description: The option's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The option's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The option's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The option's deleted at. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductTag.ts b/www/utils/generated/oas-output/schemas/BaseProductTag.ts new file mode 100644 index 0000000000..49c9639b54 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductTag.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseProductTag + * type: object + * description: The tag's tags. + * x-schemaName: BaseProductTag + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseProductVariant.ts b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts new file mode 100644 index 0000000000..4c7c81fccc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/BaseProductVariant.ts @@ -0,0 +1,8 @@ +/** + * @schema BaseProductVariant + * type: object + * description: The variant's variants. + * x-schemaName: BaseProductVariant + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/Campaign.ts b/www/utils/generated/oas-output/schemas/Campaign.ts deleted file mode 100644 index 11c0194c96..0000000000 --- a/www/utils/generated/oas-output/schemas/Campaign.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema Campaign - * type: object - * description: The promotion's campaign. - * x-schemaName: Campaign - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CampaignBudget.ts b/www/utils/generated/oas-output/schemas/CampaignBudget.ts deleted file mode 100644 index aad7d6d4c5..0000000000 --- a/www/utils/generated/oas-output/schemas/CampaignBudget.ts +++ /dev/null @@ -1,18 +0,0 @@ -/** - * @schema CampaignBudget - * type: object - * description: The campaign's budget. - * x-schemaName: CampaignBudget - * properties: - * type: - * type: string - * enum: - * - spend - * - usage - * limit: - * type: number - * title: limit - * description: The budget's limit. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateAddress.ts b/www/utils/generated/oas-output/schemas/CreateAddress.ts index 5dc64accf8..43c3523bc5 100644 --- a/www/utils/generated/oas-output/schemas/CreateAddress.ts +++ b/www/utils/generated/oas-output/schemas/CreateAddress.ts @@ -51,7 +51,6 @@ * metadata: * type: object * description: The shipping address's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/CreateApplicationMethod.ts b/www/utils/generated/oas-output/schemas/CreateApplicationMethod.ts deleted file mode 100644 index 9dbe602727..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateApplicationMethod.ts +++ /dev/null @@ -1,166 +0,0 @@ -/** - * @schema CreateApplicationMethod - * type: object - * description: The promotion's application method. - * x-schemaName: CreateApplicationMethod - * required: - * - type - * - target_type - * properties: - * type: - * type: string - * enum: - * - fixed - * - percentage - * target_type: - * type: string - * enum: - * - order - * - shipping_methods - * - items - * allocation: - * type: string - * enum: - * - each - * - across - * value: - * type: number - * title: value - * description: The application method's value. - * max_quantity: - * type: number - * title: max_quantity - * description: The application method's max quantity. - * buy_rules_min_quantity: - * type: number - * title: buy_rules_min_quantity - * description: The application method's buy rules min quantity. - * apply_to_quantity: - * type: number - * title: apply_to_quantity - * description: The application method's apply to quantity. - * promotion: - * oneOf: - * - type: string - * title: promotion - * description: The application method's promotion. - * - type: object - * description: The application method's promotion. - * x-schemaName: Promotion - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. - * code: - * type: string - * title: code - * description: The promotion's code. - * type: - * type: string - * enum: - * - standard - * - buyget - * is_automatic: - * type: boolean - * title: is_automatic - * description: The promotion's is automatic. - * application_method: - * $ref: "#/components/schemas/ApplicationMethod" - * rules: - * type: array - * description: The promotion's rules. - * items: - * type: object - * description: The rule's rules. - * x-schemaName: PromotionRule - * properties: {} - * campaign: - * $ref: "#/components/schemas/Campaign" - * target_rules: - * type: array - * description: The application method's target rules. - * items: - * type: object - * description: The target rule's target rules. - * x-schemaName: CreatePromotionRule - * required: - * - attribute - * - operator - * - values - * properties: - * description: - * type: string - * title: description - * description: The target rule's description. - * attribute: - * type: string - * title: attribute - * description: The target rule's attribute. - * operator: - * type: string - * enum: - * - gt - * - lt - * - eq - * - ne - * - in - * - lte - * - gte - * values: - * oneOf: - * - type: string - * title: values - * description: The target rule's values. - * - type: array - * description: The target rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * buy_rules: - * type: array - * description: The application method's buy rules. - * items: - * type: object - * description: The buy rule's buy rules. - * x-schemaName: CreatePromotionRule - * required: - * - attribute - * - operator - * - values - * properties: - * description: - * type: string - * title: description - * description: The buy rule's description. - * attribute: - * type: string - * title: attribute - * description: The buy rule's attribute. - * operator: - * type: string - * enum: - * - gt - * - lt - * - eq - * - ne - * - in - * - lte - * - gte - * values: - * oneOf: - * - type: string - * title: values - * description: The buy rule's values. - * - type: array - * description: The buy rule's values. - * items: - * type: string - * title: values - * description: The value's values. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateCampaignBudget.ts b/www/utils/generated/oas-output/schemas/CreateCampaignBudget.ts deleted file mode 100644 index 03b3fd1dcf..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateCampaignBudget.ts +++ /dev/null @@ -1,25 +0,0 @@ -/** - * @schema CreateCampaignBudget - * type: object - * description: The campaign's budget. - * x-schemaName: CreateCampaignBudget - * required: - * - type - * - limit - * properties: - * type: - * type: string - * enum: - * - spend - * - usage - * limit: - * type: number - * title: limit - * description: The budget's limit. - * used: - * type: number - * title: used - * description: The budget's used. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateCartAddress.ts b/www/utils/generated/oas-output/schemas/CreateCartAddress.ts index a2aa9c28db..e88ef0b05b 100644 --- a/www/utils/generated/oas-output/schemas/CreateCartAddress.ts +++ b/www/utils/generated/oas-output/schemas/CreateCartAddress.ts @@ -47,7 +47,6 @@ * metadata: * type: object * description: The billing address's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/CreateCartCreateLineItem.ts b/www/utils/generated/oas-output/schemas/CreateCartCreateLineItem.ts index 53c9e8a961..990c11c653 100644 --- a/www/utils/generated/oas-output/schemas/CreateCartCreateLineItem.ts +++ b/www/utils/generated/oas-output/schemas/CreateCartCreateLineItem.ts @@ -70,7 +70,6 @@ * variant_option_values: * type: object * description: The item's variant option values. - * properties: {} * requires_shipping: * type: boolean * title: requires_shipping @@ -98,7 +97,6 @@ * metadata: * type: object * description: The item's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts b/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts index 3f8e45ad0a..4da68eb2ef 100644 --- a/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts +++ b/www/utils/generated/oas-output/schemas/CreateCartWorkflowInput.ts @@ -48,7 +48,6 @@ * metadata: * type: object * description: The cart's metadata. - * properties: {} * items: * type: array * description: The cart's items. diff --git a/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts b/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts new file mode 100644 index 0000000000..29b79e74cf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts @@ -0,0 +1,31 @@ +/** + * @schema CreateOrderReturnReason + * type: object + * description: SUMMARY + * x-schemaName: CreateOrderReturnReason + * required: + * - value + * - label + * properties: + * value: + * type: string + * title: value + * description: The return reason's value. + * label: + * type: string + * title: label + * description: The return reason's label. + * description: + * type: string + * title: description + * description: The return reason's description. + * parent_return_reason_id: + * type: string + * title: parent_return_reason_id + * description: The return reason's parent return reason id. + * metadata: + * type: object + * description: The return reason's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/CreateProduct.ts b/www/utils/generated/oas-output/schemas/CreateProduct.ts deleted file mode 100644 index f2b15787f0..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateProduct.ts +++ /dev/null @@ -1,117 +0,0 @@ -/** - * @schema CreateProduct - * type: object - * description: SUMMARY - * x-schemaName: CreateProduct - * required: - * - title - * properties: - * title: - * type: string - * title: title - * description: The upload's title. - * subtitle: - * type: string - * title: subtitle - * description: The upload's subtitle. - * description: - * type: string - * title: description - * description: The upload's description. - * is_giftcard: - * type: boolean - * title: is_giftcard - * description: The upload's is giftcard. - * discountable: - * type: boolean - * title: discountable - * description: The upload's discountable. - * thumbnail: - * type: string - * title: thumbnail - * description: The upload's thumbnail. - * handle: - * type: string - * title: handle - * description: The upload's handle. - * status: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * images: - * type: array - * description: The upload's images. - * items: - * $ref: "#/components/schemas/UpsertProductImage" - * type_id: - * type: string - * title: type_id - * description: The upload's type id. - * collection_id: - * type: string - * title: collection_id - * description: The upload's collection id. - * tags: - * type: array - * description: The upload's tags. - * items: - * $ref: "#/components/schemas/UpsertProductTag" - * category_ids: - * type: array - * description: The upload's category ids. - * items: - * type: string - * title: category_ids - * description: The category id's category ids. - * options: - * type: array - * description: The upload's options. - * items: - * $ref: "#/components/schemas/CreateProductOption" - * variants: - * type: array - * description: The upload's variants. - * items: - * $ref: "#/components/schemas/CreateProductVariant" - * width: - * type: number - * title: width - * description: The upload's width. - * height: - * type: number - * title: height - * description: The upload's height. - * length: - * type: number - * title: length - * description: The upload's length. - * weight: - * type: number - * title: weight - * description: The upload's weight. - * origin_country: - * type: string - * title: origin_country - * description: The upload's origin country. - * hs_code: - * type: string - * title: hs_code - * description: The upload's hs code. - * material: - * type: string - * title: material - * description: The upload's material. - * mid_code: - * type: string - * title: mid_code - * description: The upload's mid code. - * metadata: - * type: object - * description: The upload's metadata. - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateProductOption.ts b/www/utils/generated/oas-output/schemas/CreateProductOption.ts deleted file mode 100644 index 20d1f65324..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateProductOption.ts +++ /dev/null @@ -1,27 +0,0 @@ -/** - * @schema CreateProductOption - * type: object - * description: The option's options. - * x-schemaName: CreateProductOption - * required: - * - title - * - values - * properties: - * title: - * type: string - * title: title - * description: The option's title. - * values: - * type: array - * description: The option's values. - * items: - * type: string - * title: values - * description: The value's values. - * product_id: - * type: string - * title: product_id - * description: The option's product id. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateProductType.ts b/www/utils/generated/oas-output/schemas/CreateProductType.ts deleted file mode 100644 index b2535aee04..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateProductType.ts +++ /dev/null @@ -1,23 +0,0 @@ -/** - * @schema CreateProductType - * type: object - * description: The product's type. - * x-schemaName: CreateProductType - * required: - * - value - * properties: - * id: - * type: string - * title: id - * description: The type's ID. - * value: - * type: string - * title: value - * description: The type's value. - * metadata: - * type: object - * description: The type's metadata. - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateProductVariant.ts b/www/utils/generated/oas-output/schemas/CreateProductVariant.ts deleted file mode 100644 index 06374a31d7..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateProductVariant.ts +++ /dev/null @@ -1,87 +0,0 @@ -/** - * @schema CreateProductVariant - * type: object - * description: The variant's variants. - * x-schemaName: CreateProductVariant - * required: - * - title - * properties: - * product_id: - * type: string - * title: product_id - * description: The variant's product id. - * title: - * type: string - * title: title - * description: The variant's title. - * sku: - * type: string - * title: sku - * description: The variant's sku. - * barcode: - * type: string - * title: barcode - * description: The variant's barcode. - * ean: - * type: string - * title: ean - * description: The variant's ean. - * upc: - * type: string - * title: upc - * description: The variant's upc. - * allow_backorder: - * type: boolean - * title: allow_backorder - * description: The variant's allow backorder. - * inventory_quantity: - * type: number - * title: inventory_quantity - * description: The variant's inventory quantity. - * manage_inventory: - * type: boolean - * title: manage_inventory - * description: The variant's manage inventory. - * hs_code: - * type: string - * title: hs_code - * description: The variant's hs code. - * origin_country: - * type: string - * title: origin_country - * description: The variant's origin country. - * mid_code: - * type: string - * title: mid_code - * description: The variant's mid code. - * material: - * type: string - * title: material - * description: The variant's material. - * weight: - * type: number - * title: weight - * description: The variant's weight. - * length: - * type: number - * title: length - * description: The variant's length. - * height: - * type: number - * title: height - * description: The variant's height. - * width: - * type: number - * title: width - * description: The variant's width. - * options: - * type: object - * description: The variant's options. - * properties: {} - * metadata: - * type: object - * description: The variant's metadata. - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CreateUser.ts b/www/utils/generated/oas-output/schemas/CreateUser.ts index 30896463fc..2163c74bcd 100644 --- a/www/utils/generated/oas-output/schemas/CreateUser.ts +++ b/www/utils/generated/oas-output/schemas/CreateUser.ts @@ -26,7 +26,6 @@ * metadata: * type: object * description: The user's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/Customer.ts b/www/utils/generated/oas-output/schemas/Customer.ts deleted file mode 100644 index 3e9416e797..0000000000 --- a/www/utils/generated/oas-output/schemas/Customer.ts +++ /dev/null @@ -1,93 +0,0 @@ -/** - * @schema Customer - * type: object - * description: The context's customer. - * x-schemaName: Customer - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * has_account: - * type: boolean - * title: has_account - * description: The customer's has account. - * default_billing_address_id: - * type: string - * title: default_billing_address_id - * description: The customer's default billing address id. - * default_shipping_address_id: - * type: string - * title: default_shipping_address_id - * description: The customer's default shipping address id. - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * addresses: - * type: array - * description: The customer's addresses. - * items: - * $ref: "#/components/schemas/CustomerAddress" - * phone: - * type: string - * title: phone - * description: The customer's phone. - * groups: - * type: array - * description: The customer's groups. - * items: - * type: object - * description: The group's groups. - * properties: {} - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * created_by: - * type: string - * title: created_by - * description: The customer's created by. - * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * format: date-time - * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The customer's created at. - * - type: string - * title: created_at - * description: The customer's created at. - * format: date-time - * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The customer's updated at. - * - type: string - * title: updated_at - * description: The customer's updated at. - * format: date-time - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/CustomerAddress.ts b/www/utils/generated/oas-output/schemas/CustomerAddress.ts deleted file mode 100644 index a4f379eb48..0000000000 --- a/www/utils/generated/oas-output/schemas/CustomerAddress.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * @schema CustomerAddress - * type: object - * description: The address's addresses. - * x-schemaName: CustomerAddress - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/Promotion.ts b/www/utils/generated/oas-output/schemas/Promotion.ts deleted file mode 100644 index d597aaca09..0000000000 --- a/www/utils/generated/oas-output/schemas/Promotion.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @schema Promotion - * type: object - * description: The promotion's promotions. - * x-schemaName: Promotion - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The promotion's ID. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/ShippingProfileResponse.ts b/www/utils/generated/oas-output/schemas/ShippingProfileResponse.ts deleted file mode 100644 index 5c5c97906b..0000000000 --- a/www/utils/generated/oas-output/schemas/ShippingProfileResponse.ts +++ /dev/null @@ -1,48 +0,0 @@ -/** - * @schema ShippingProfileResponse - * type: object - * description: The shipping profile's details. - * x-schemaName: ShippingProfileResponse - * required: - * - id - * - name - * - type - * - metadata - * - created_at - * - updated_at - * - deleted_at - * properties: - * id: - * type: string - * title: id - * description: The shipping profile's ID. - * name: - * type: string - * title: name - * description: The shipping profile's name. - * type: - * type: string - * title: type - * description: The shipping profile's type. - * metadata: - * type: object - * description: The shipping profile's metadata. - * properties: {} - * created_at: - * type: string - * title: created_at - * description: The shipping profile's created at. - * format: date-time - * updated_at: - * type: string - * title: updated_at - * description: The shipping profile's updated at. - * format: date-time - * deleted_at: - * type: string - * title: deleted_at - * description: The shipping profile's deleted at. - * format: date-time - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts new file mode 100644 index 0000000000..c14166474e --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts @@ -0,0 +1,24 @@ +/** + * @schema StoreAddCartLineItem + * type: object + * description: SUMMARY + * x-schemaName: StoreAddCartLineItem + * required: + * - variant_id + * - quantity + * - metadata + * properties: + * variant_id: + * type: string + * title: variant_id + * description: The cart's variant id. + * quantity: + * type: number + * title: quantity + * description: The cart's quantity. + * metadata: + * type: object + * description: The cart's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts b/www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts new file mode 100644 index 0000000000..13e68b23cf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts @@ -0,0 +1,13 @@ +/** + * @schema StoreCalculateCartTaxes + * type: object + * description: SUMMARY + * x-schemaName: StoreCalculateCartTaxes + * properties: + * fields: + * type: string + * title: fields + * description: The cart's fields. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts new file mode 100644 index 0000000000..ed029e9288 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreCreateCustomer.ts @@ -0,0 +1,36 @@ +/** + * @schema StoreCreateCustomer + * type: object + * description: SUMMARY + * x-schemaName: StoreCreateCustomer + * required: + * - email + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * email: + * type: string + * title: email + * description: The customer's email. + * format: email + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts b/www/utils/generated/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts deleted file mode 100644 index a53436464a..0000000000 --- a/www/utils/generated/oas-output/schemas/StorePostPaymentCollectionsPaymentSessionReq.ts +++ /dev/null @@ -1,196 +0,0 @@ -/** - * @schema StorePostPaymentCollectionsPaymentSessionReq - * type: object - * description: SUMMARY - * x-schemaName: StorePostPaymentCollectionsPaymentSessionReq - * required: - * - provider_id - * properties: - * provider_id: - * type: string - * title: provider_id - * description: The payment collection's provider id. - * context: - * type: object - * description: The payment collection's context. - * properties: - * billing_address: - * type: object - * description: The context's billing address. - * properties: - * id: - * type: string - * title: id - * description: The billing address's ID. - * address_1: - * type: string - * title: address_1 - * description: The billing address's address 1. - * address_2: - * type: string - * title: address_2 - * description: The billing address's address 2. - * company: - * type: string - * title: company - * description: The billing address's company. - * country_code: - * type: string - * title: country_code - * description: The billing address's country code. - * city: - * type: string - * title: city - * description: The billing address's city. - * phone: - * type: string - * title: phone - * description: The billing address's phone. - * postal_code: - * type: string - * title: postal_code - * description: The billing address's postal code. - * province: - * type: string - * title: province - * description: The billing address's province. - * metadata: - * type: object - * description: The billing address's metadata. - * properties: {} - * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The billing address's created at. - * - type: string - * title: created_at - * description: The billing address's created at. - * format: date-time - * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The billing address's updated at. - * - type: string - * title: updated_at - * description: The billing address's updated at. - * format: date-time - * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The billing address's deleted at. - * - type: string - * title: deleted_at - * description: The billing address's deleted at. - * format: date-time - * email: - * type: string - * title: email - * description: The context's email. - * format: email - * resource_id: - * type: string - * title: resource_id - * description: The context's resource id. - * customer: - * type: object - * description: The context's customer. - * x-schemaName: Customer - * properties: - * id: - * type: string - * title: id - * description: The customer's ID. - * email: - * type: string - * title: email - * description: The customer's email. - * format: email - * has_account: - * type: boolean - * title: has_account - * description: The customer's has account. - * default_billing_address_id: - * type: string - * title: default_billing_address_id - * description: The customer's default billing address id. - * default_shipping_address_id: - * type: string - * title: default_shipping_address_id - * description: The customer's default shipping address id. - * company_name: - * type: string - * title: company_name - * description: The customer's company name. - * first_name: - * type: string - * title: first_name - * description: The customer's first name. - * last_name: - * type: string - * title: last_name - * description: The customer's last name. - * addresses: - * type: array - * description: The customer's addresses. - * items: - * $ref: "#/components/schemas/CustomerAddress" - * phone: - * type: string - * title: phone - * description: The customer's phone. - * groups: - * type: array - * description: The customer's groups. - * items: - * type: object - * description: The group's groups. - * properties: {} - * metadata: - * type: object - * description: The customer's metadata. - * properties: {} - * created_by: - * type: string - * title: created_by - * description: The customer's created by. - * deleted_at: - * oneOf: - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * - type: string - * title: deleted_at - * description: The customer's deleted at. - * format: date-time - * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The customer's created at. - * - type: string - * title: created_at - * description: The customer's created at. - * format: date-time - * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The customer's updated at. - * - type: string - * title: updated_at - * description: The customer's updated at. - * format: date-time - * extra: - * type: object - * description: The context's extra. - * properties: {} - * data: - * type: object - * description: The payment collection's data. - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts new file mode 100644 index 0000000000..086ec2e0c9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StorePostReturnsReqSchema.ts @@ -0,0 +1,73 @@ +/** + * @schema StorePostReturnsReqSchema + * type: object + * description: SUMMARY + * x-schemaName: StorePostReturnsReqSchema + * required: + * - order_id + * - items + * - return_shipping + * - note + * - location_id + * properties: + * order_id: + * type: string + * title: order_id + * description: The return's order id. + * items: + * type: array + * description: The return's items. + * items: + * type: object + * description: The item's items. + * required: + * - id + * - quantity + * - reason_id + * - note + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * reason_id: + * type: string + * title: reason_id + * description: The item's reason id. + * note: + * type: string + * title: note + * description: The item's note. + * return_shipping: + * type: object + * description: The return's return shipping. + * required: + * - option_id + * properties: + * option_id: + * type: string + * title: option_id + * description: The return shipping's option id. + * price: + * type: number + * title: price + * description: The return shipping's price. + * note: + * type: string + * title: note + * description: The return's note. + * receive_now: + * type: boolean + * title: receive_now + * description: The return's receive now. + * location_id: + * type: string + * title: location_id + * description: The return's location id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts new file mode 100644 index 0000000000..2550a5194f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -0,0 +1,167 @@ +/** + * @schema StoreProduct + * type: object + * description: The product's products. + * x-schemaName: StoreProduct + * required: + * - title + * - status + * - length + * - options + * - description + * - id + * - handle + * - hs_code + * - weight + * - height + * - width + * - origin_country + * - mid_code + * - material + * - thumbnail + * - created_at + * - updated_at + * - deleted_at + * - variants + * - subtitle + * - is_giftcard + * - collection_id + * - type_id + * - tags + * - images + * - discountable + * - external_id + * properties: + * categories: + * type: array + * description: The product's categories. + * items: + * $ref: "#/components/schemas/StoreProductCategory" + * type: + * $ref: "#/components/schemas/StoreProduct" + * title: + * type: string + * title: title + * description: The product's title. + * status: + * type: string + * enum: + * - draft + * - proposed + * - published + * - rejected + * length: + * type: number + * title: length + * description: The product's length. + * options: + * type: array + * description: The product's options. + * items: + * $ref: "#/components/schemas/BaseProductOption" + * description: + * type: string + * title: description + * description: The product's description. + * id: + * type: string + * title: id + * description: The product's ID. + * handle: + * type: string + * title: handle + * description: The product's handle. + * metadata: + * type: object + * description: The product's metadata. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * width: + * type: number + * title: width + * description: The product's width. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * variants: + * type: array + * description: The product's variants. + * items: + * $ref: "#/components/schemas/BaseProductVariant" + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * collection: + * $ref: "#/components/schemas/BaseCollection" + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * tags: + * type: array + * description: The product's tags. + * items: + * $ref: "#/components/schemas/BaseProductTag" + * images: + * type: array + * description: The product's images. + * items: + * $ref: "#/components/schemas/BaseProductImage" + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/ProductCategoryResponse.ts b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts similarity index 64% rename from www/utils/generated/oas-output/schemas/ProductCategoryResponse.ts rename to www/utils/generated/oas-output/schemas/StoreProductCategory.ts index 3f35e86934..53b35f8271 100644 --- a/www/utils/generated/oas-output/schemas/ProductCategoryResponse.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategory.ts @@ -1,8 +1,8 @@ /** - * @schema ProductCategoryResponse + * @schema StoreProductCategory * type: object * description: The product category's details. - * x-schemaName: ProductCategoryResponse + * x-schemaName: StoreProductCategory * required: * - id * - name @@ -12,11 +12,17 @@ * - is_internal * - rank * - parent_category_id - * - created_at - * - updated_at * - parent_category * - category_children + * - created_at + * - updated_at + * - deleted_at * properties: + * products: + * type: array + * description: The product category's products. + * items: + * $ref: "#/components/schemas/StoreProduct" * id: * type: string * title: id @@ -49,31 +55,28 @@ * type: string * title: parent_category_id * description: The product category's parent category id. - * created_at: - * oneOf: - * - type: string - * title: created_at - * description: The product category's created at. - * - type: string - * title: created_at - * description: The product category's created at. - * format: date-time - * updated_at: - * oneOf: - * - type: string - * title: updated_at - * description: The product category's updated at. - * - type: string - * title: updated_at - * description: The product category's updated at. - * format: date-time * parent_category: - * $ref: "#/components/schemas/ProductCategoryResponse" + * $ref: "#/components/schemas/BaseProductCategory" * category_children: * type: array * description: The product category's category children. * items: - * $ref: "#/components/schemas/ProductCategoryResponse" + * $ref: "#/components/schemas/BaseProductCategory" + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product category's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product category's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product category's deleted at. * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductCategoryListResponse.ts b/www/utils/generated/oas-output/schemas/StoreProductCategoryListResponse.ts index 26dc52a02a..199d196222 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductCategoryListResponse.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategoryListResponse.ts @@ -4,16 +4,11 @@ * description: SUMMARY * x-schemaName: StoreProductCategoryListResponse * required: - * - product_categories * - limit * - offset * - count + * - product_categories * properties: - * product_categories: - * type: array - * description: The product category's product categories. - * items: - * $ref: "#/components/schemas/ProductCategoryResponse" * limit: * type: number * title: limit @@ -26,6 +21,11 @@ * type: number * title: count * description: The product category's count. + * product_categories: + * type: array + * description: The product category's product categories. + * items: + * $ref: "#/components/schemas/StoreProductCategory" * */ diff --git a/www/utils/generated/oas-output/schemas/StoreProductCategoryResponse.ts b/www/utils/generated/oas-output/schemas/StoreProductCategoryResponse.ts index f1ddfc5b1c..0e2deee816 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductCategoryResponse.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductCategoryResponse.ts @@ -7,7 +7,7 @@ * - product_category * properties: * product_category: - * $ref: "#/components/schemas/ProductCategoryResponse" + * $ref: "#/components/schemas/StoreProductCategory" * */ diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts new file mode 100644 index 0000000000..73f0ad2a01 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts @@ -0,0 +1,19 @@ +/** + * @schema StoreUpdateCartLineItem + * type: object + * description: SUMMARY + * x-schemaName: StoreUpdateCartLineItem + * required: + * - quantity + * - metadata + * properties: + * quantity: + * type: number + * title: quantity + * description: The cart's quantity. + * metadata: + * type: object + * description: The cart's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts new file mode 100644 index 0000000000..f72ce46ef9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts @@ -0,0 +1,30 @@ +/** + * @schema StoreUpdateCustomer + * type: object + * description: SUMMARY + * x-schemaName: StoreUpdateCustomer + * required: + * - company_name + * - first_name + * - last_name + * - phone + * properties: + * company_name: + * type: string + * title: company_name + * description: The customer's company name. + * first_name: + * type: string + * title: first_name + * description: The customer's first name. + * last_name: + * type: string + * title: last_name + * description: The customer's last name. + * phone: + * type: string + * title: phone + * description: The customer's phone. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/UpdateAddress.ts b/www/utils/generated/oas-output/schemas/UpdateAddress.ts index 40af01f2fc..a09fd49e75 100644 --- a/www/utils/generated/oas-output/schemas/UpdateAddress.ts +++ b/www/utils/generated/oas-output/schemas/UpdateAddress.ts @@ -57,7 +57,6 @@ * metadata: * type: object * description: The shipping address's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/UpdateCartData.ts b/www/utils/generated/oas-output/schemas/UpdateCartData.ts index fb7b92e125..62a5481a5e 100644 --- a/www/utils/generated/oas-output/schemas/UpdateCartData.ts +++ b/www/utils/generated/oas-output/schemas/UpdateCartData.ts @@ -44,7 +44,6 @@ * metadata: * type: object * description: The cart's metadata. - * properties: {} * */ diff --git a/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts b/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts new file mode 100644 index 0000000000..a0f728d71d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts @@ -0,0 +1,28 @@ +/** + * @schema UpdateOrderReturnReason + * type: object + * description: SUMMARY + * x-schemaName: UpdateOrderReturnReason + * properties: + * id: + * type: string + * title: id + * description: The return reason's ID. + * label: + * type: string + * title: label + * description: The return reason's label. + * value: + * type: string + * title: value + * description: The return reason's value. + * description: + * type: string + * title: description + * description: The return reason's description. + * metadata: + * type: object + * description: The return reason's metadata. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/UpsertProductImage.ts b/www/utils/generated/oas-output/schemas/UpsertProductImage.ts deleted file mode 100644 index 7ddc2176ea..0000000000 --- a/www/utils/generated/oas-output/schemas/UpsertProductImage.ts +++ /dev/null @@ -1,21 +0,0 @@ -/** - * @schema UpsertProductImage - * type: object - * description: The image's images. - * x-schemaName: UpsertProductImage - * properties: - * id: - * type: string - * title: id - * description: The image's ID. - * url: - * type: string - * title: url - * description: The image's url. - * metadata: - * type: object - * description: The image's metadata. - * properties: {} - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/UpsertProductTag.ts b/www/utils/generated/oas-output/schemas/UpsertProductTag.ts deleted file mode 100644 index f726f84ef2..0000000000 --- a/www/utils/generated/oas-output/schemas/UpsertProductTag.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** - * @schema UpsertProductTag - * type: object - * description: The tag's tags. - * x-schemaName: UpsertProductTag - * properties: - * id: - * type: string - * title: id - * description: The tag's ID. - * value: - * type: string - * title: value - * description: The tag's value. - * -*/ -