chore(docs): Generated API Reference (#4706)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
github-actions[bot]
2023-08-07 16:54:48 +03:00
committed by GitHub
parent efdea04963
commit 658339767b
1138 changed files with 11740 additions and 7043 deletions

View File

@@ -2,13 +2,16 @@ get:
operationId: GetInventoryItems
summary: List Inventory Items
description: >-
Lists inventory items with the ability to apply filters or search queries on
them.
Retrieve a list of inventory items. The inventory items can be filtered by
fields such as `q` or `location_id`. The inventory items can also be
paginated.
x-authenticated: true
parameters:
- in: query
name: offset
description: How many inventory items to skip in the result.
description: >-
The number of inventory items to skip when retrieving the inventory
items.
schema:
type: integer
default: 0
@@ -20,81 +23,93 @@ get:
default: 20
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in each returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
- in: query
name: q
description: Query used for searching product inventory items and their properties.
description: term to search inventory item's sku, title, and description.
schema:
type: string
- in: query
name: location_id
style: form
explode: false
description: Locations ids to search for.
description: Filter by location IDs.
schema:
type: array
items:
type: string
- in: query
name: id
description: id to search for.
style: form
explode: false
description: Filter by the inventory ID
schema:
type: string
oneOf:
- type: string
description: inventory ID
- type: array
description: an array of inventory IDs
items:
type: string
- in: query
name: sku
description: sku to search for.
description: Filter by SKU
schema:
type: string
- in: query
name: origin_country
description: origin_country to search for.
description: Filter by origin country
schema:
type: string
- in: query
name: mid_code
description: mid_code to search for.
description: Filter by MID code
schema:
type: string
- in: query
name: material
description: material to search for.
description: Filter by material
schema:
type: string
- in: query
name: hs_code
description: hs_code to search for.
description: Filter by HS Code
schema:
type: string
- in: query
name: weight
description: weight to search for.
description: Filter by weight
schema:
type: string
- in: query
name: length
description: length to search for.
description: Filter by length
schema:
type: string
- in: query
name: height
description: height to search for.
description: Filter by height
schema:
type: string
- in: query
name: width
description: width to search for.
description: Filter by width
schema:
type: string
- in: query
name: requires_shipping
description: requires_shipping to search for.
description: Filter by whether the item requires shipping
schema:
type: string
x-codegen:
@@ -137,17 +152,21 @@ get:
post:
operationId: PostInventoryItems
summary: Create an Inventory Item
description: Creates an Inventory Item.
description: Create an Inventory Item.
x-authenticated: true
parameters:
- in: query
name: expand
description: Comma separated list of relations to include in the results.
description: >-
Comma-separated relations that should be expanded in the returned
inventory item.
schema:
type: string
- in: query
name: fields
description: Comma separated list of fields to include in the results.
description: >-
Comma-separated fields that should be included in the returned inventory
item.
schema:
type: string
requestBody: