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

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andShahed Nasser authored and GitHub committed 2024-09-06 12:25:48 +00:00
1 parent 20545b194e
commit cf3c25addf
535 files changed
+3668 -23178

No files matched your search

@@ -35,30 +35,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -47,117 +47,59 @@
* type: string
* title: order
* description: The 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
* required: false
* schema:
* type: string
* title: city
* description: The customer's city.
* oneOf:
* - type: string
* title: city
* description: The customer's city.
* - type: array
* description: The customer's city.
* items:
* type: string
* title: city
* description: The city's details.
* - name: country_code
* in: query
* description: The customer's country code.
* required: true
* required: false
* 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.
* oneOf:
* - type: string
* title: country_code
* description: The customer's country code.
* - type: array
* description: The customer's country code.
* items:
* type: string
* title: country_code
* description: The country code's details.
* - 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
* oneOf:
* - type: string
* title: postal_code
* description: The customer's postal code.
* - type: array
* description: The customer's postal code.
* items:
* type: string
* title: postal_code
* description: The postal code's details.
* - name: q
* in: query
* description: The customer's is default billing.
* description: The customer's q.
* required: false
* schema:
* type: boolean
* title: is_default_billing
* description: The customer's is default billing.
* type: string
* title: q
* description: The customer's q.
* security:
* - cookie_auth: []
* - jwt_token: []
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -3,7 +3,7 @@
* 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
* x-authenticated: true
* parameters:
* - name: expand
* in: query
@@ -61,20 +61,6 @@
* 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
@@ -93,6 +79,41 @@
* items:
* type: object
* title: $or
* - name: status
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: status
* description: The order's status.
* - type: string
* title: status
* description: The order's status.
* - type: string
* title: status
* description: The order's status.
* - type: string
* title: status
* description: The order's status.
* - type: string
* title: status
* description: The order's status.
* - type: string
* title: status
* description: The order's status.
* - type: array
* description: The order's status.
* items:
* type: string
* description: The status's details.
* enum:
* - canceled
* - requires_action
* - pending
* - completed
* - draft
* - archived
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -147,6 +168,9 @@
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* security:
* - cookie_auth: []
* - jwt_token: []
*
*/
@@ -29,76 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
* type: array
* description: The order's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema:
* type: array
* description: The order's $or.
* items:
* type: object
* title: $or
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -50,58 +50,11 @@
* - name: region_id
* in: query
* description: The payment provider's region id.
* required: false
* required: true
* schema:
* oneOf:
* - type: string
* title: region_id
* description: The payment provider's region id.
* - type: array
* description: The payment provider's region id.
* items:
* type: string
* title: region_id
* description: The region id's details.
* - 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:
* type: array
* description: The payment provider's $and.
* items:
* type: object
* title: $and
* - name: $or
* in: query
* required: false
* schema:
* type: array
* description: The payment provider's $or.
* items:
* type: object
* title: $or
* type: string
* title: region_id
* description: The payment provider's region id.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -852,22 +852,6 @@
* type: string
* title: name
* description: The name's details.
* - name: is_active
* in: query
* description: The product category's is active.
* required: false
* schema:
* type: boolean
* title: is_active
* description: The product category's is active.
* - name: is_internal
* in: query
* description: The product category's is internal.
* required: false
* schema:
* type: boolean
* title: is_internal
* description: The product category's is internal.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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.
@@ -137,21 +137,6 @@
* type: string
* title: collection_id
* description: The collection id's details.
* - name: tags
* in: query
* description: The product's tags.
* required: false
* schema:
* oneOf:
* - type: string
* title: tags
* description: The product's tags.
* - 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.
@@ -828,393 +813,6 @@
* type: boolean
* title: $exists
* description: The deleted at's $exists.
* - 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: 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: array
* description: The $and's details.
* items: &a1
* type: object
* title: $and
* - 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: array
* description: The $and's details.
* items: *a1
* title: $and
* - type: object
* description: The $and's details.
* x-schemaName: RegExp
* $or:
* type: array
* description: The id's $or.
* items:
* oneOf:
* - type: array
* description: The $or's details.
* items: &a2
* type: object
* title: $or
* - 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: array
* description: The $or's details.
* items: *a2
* title: $or
* - 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:
* type: array
* description: The $and's details.
* items: *a1
* title: $and
* $or:
* type: array
* description: The id's $or.
* items:
* type: array
* description: The $or's details.
* items:
* type: array
* description: The $or's details.
* items: *a2
* title: $or
* $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: region_id
* in: query
* description: The product's region id.
@@ -1267,6 +865,20 @@
* type: string
* title: category_id
* description: The category id's details.
* - name: tag_id
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: tag_id
* description: The product's tag id.
* - type: array
* description: The product's tag id.
* items:
* type: string
* title: tag_id
* description: The tag id's details.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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 product's region id.
@@ -492,482 +492,6 @@
* type: string
* title: name
* description: The name's details.
* - 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: created_at
* in: query
* description: The region's created at.
* required: false
* schema:
* type: object
* description: The region's created at.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: updated_at
* in: query
* description: The region's updated at.
* required: false
* schema:
* type: object
* description: The region's updated at.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* properties:
* $and:
* type: array
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $and
* $or:
* type: array
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
* items:
* type: object
* title: $or
* $eq:
* oneOf:
* - type: string
* title: $eq
* description: Filter by an exact match.
* - type: array
* description: Filter by an exact match.
* items:
* type: string
* title: $eq
* description: Filter by an exact match.
* $ne:
* type: string
* title: $ne
* description: Filter by values not equal to this parameter.
* $in:
* type: array
* description: Filter by values in this array.
* items:
* type: string
* title: $in
* description: Filter by values in this array.
* $nin:
* type: array
* description: Filter by values not in this array.
* items:
* type: string
* title: $nin
* description: Filter by values not in this array.
* $not:
* oneOf:
* - type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* - type: object
* description: Filter by values not matching the conditions in this parameter.
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - type: array
* description: Filter by values not matching the conditions in this parameter.
* items:
* type: string
* title: $not
* description: Filter by values not matching the conditions in this parameter.
* $gt:
* type: string
* title: $gt
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
* $gte:
* type: string
* title: $gte
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
* $lt:
* type: string
* title: $lt
* description: Filter by values less than this parameter. Useful for numbers and dates only.
* $lte:
* type: string
* title: $lte
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
* $like:
* type: string
* title: $like
* description: Apply a `like` filter. Useful for strings only.
* $re:
* type: string
* title: $re
* description: Apply a regex filter. Useful for strings only.
* $ilike:
* type: string
* title: $ilike
* description: Apply a case-insensitive `like` filter. Useful for strings only.
* $fulltext:
* type: string
* title: $fulltext
* description: Filter to apply on full-text properties.
* $overlap:
* type: array
* description: Filter arrays that have overlapping values with this parameter.
* items:
* type: string
* title: $overlap
* description: Filter arrays that have overlapping values with this parameter.
* $contains:
* type: array
* description: Filter arrays that contain some of the values of this parameter.
* items:
* type: string
* title: $contains
* description: Filter arrays that contain some of the values of this parameter.
* $contained:
* type: array
* description: Filter arrays that contain all values of this parameter.
* items:
* type: string
* title: $contained
* description: Filter arrays that contain all values of this parameter.
* $exists:
* type: boolean
* title: $exists
* description: Filter by whether a value for this parameter exists (not `null`).
* - name: $and
* in: query
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
@@ -988,6 +512,20 @@
* items:
* type: object
* title: $or
* - name: currency_code
* in: query
* required: false
* schema:
* oneOf:
* - type: string
* title: currency_code
* description: The region's currency code.
* - type: array
* description: The region's currency code.
* items:
* type: string
* title: currency_code
* description: The currency code's details.
* x-codeSamples:
* - lang: Shell
* label: cURL
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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
@@ -5,14 +5,6 @@
* 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
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -35,30 +35,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -56,19 +32,6 @@
* 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
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field 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: []
@@ -62,19 +38,6 @@
* 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
@@ -23,30 +23,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -29,30 +29,6 @@
* title: fields
* description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
* fields. without prefix it will replace the entire default fields.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The 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:
@@ -4,7 +4,6 @@
* summary: Create Return
* description: Create a return.
* x-authenticated: false
* parameters: []
* requestBody:
* content:
* application/json: