Stocks

inventory Api Stock Repository V1Get Get

Get Stock data by given stockId. If you want to create plugin on get method, also you need to create separate plugin on getList method, because entity loading way is different for these methods

get

/V1/inventory/stocks/{stockId}

Path parameters

stockIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/inventory/stocks/{stockId}'

200

400

401

500

200

{
  "stock_id": 4692958,
  "name": "reprehenderit consequat",
  "extension_attributes": {
    "sales_channels": [
      {
        "type": "sit incididunt nulla consectetur",
        "code": "id",
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      },
      {
        "type": "do reprehenderit ea",
        "code": "aliquip elit Excepteur",
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    ]
  }
}

OK

inventory Api Stock Repository V1Save Put

Save Stock data

put

/V1/inventory/stocks/{stockId}

Path parameters

stockIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"stock":{"stock_id":-88693904,"name":"est proident ut laboris adipisicing","extension_attributes":{"sales_channels":[{"type":"mollit Ut tempor occaecat","code":"in nisi dolor","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"type":"mollit nostrud","code":"minim sed","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/inventory/stocks/{stockId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "stock": {
      "stock_id": -88693904,
      "name": "est proident ut laboris adipisicing",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "mollit Ut tempor occaecat",
            "code": "in nisi dolor",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "mollit nostrud",
            "code": "minim sed",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    }
  }'

200

400

401

500

200

66689314

OK

inventory Api Stock Repository V1Delete By Id Delete

Delete the Stock data by stockId. If stock is not found do nothing

delete

/V1/inventory/stocks/{stockId}

Path parameters

stockIdstringrequired

(Required)

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/inventory/stocks/{stockId}'

400

401

500

400

{
  "message": "sint adipisicing officia veniam",
  "errors": [
    {
      "message": "anim exercitation officia proident",
      "parameters": [
        {
          "resources": "ullamco dolore velit",
          "fieldName": "sint",
          "fieldValue": "aliqua sit"
        },
        {
          "resources": "mollit nisi",
          "fieldName": "adipisicing quis sit",
          "fieldValue": "irure ut sint"
        }
      ]
    },
    {
      "message": "consectetur dolor velit",
      "parameters": [
        {
          "resources": "ad",
          "fieldName": "id ad exercitation aliqua",
          "fieldValue": "ullamco labore culpa sunt"
        },
        {
          "resources": "aliqua Ut sunt",
          "fieldName": "ea qui ipsum incididunt deserunt",
          "fieldValue": "aliquip mollit"
        }
      ]
    }
  ],
  "code": -28507465,
  "parameters": [
    {
      "resources": "reprehe",
      "fieldName": "labore c",
      "fieldValue": "am"
    },
    {
      "resources": "et magna",
      "fieldName": "ea ipsum ut",
      "fieldValue": "consectetur proident ex"
    }
  ],
  "trace": "occaecat deserunt"
}

Bad Request

inventory Api Stock Repository V1Get List Get

Find Stocks by given SearchCriteria SearchCriteria is not required because load all stocks is useful case

get

/V1/inventory/stocks

Query parameters

searchCriteria[filterGroups][0][filters][0][field]string

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]string

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]string

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]string

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]string

Sorting direction.

Example: <string>

searchCriteria[pageSize]string

Page size.

Example: <integer>

searchCriteria[currentPage]string

Current page.

Example: <integer>

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://{{baseurl}}/V1/inventory/stocks'

200

401

500

200

{
  "items": [
    {
      "stock_id": 1959978,
      "name": "Excepteur",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "reprehenderit",
            "code": "proident Duis fugiat",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "minim voluptate ",
            "code": "Duis commodo dolore consequat",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    },
    {
      "stock_id": 16437491,
      "name": "non in est",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "Lorem minim incididunt",
            "code": "in cupidatat est",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "in Duis Lorem",
            "code": "sunt Ut adipisicing deserunt",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "Excepteur amet",
            "value": "nulla consequat ut laborum in",
            "condition_type": "sit"
          },
          {
            "field": "dolore labore",
            "value": "occaecat culpa sint dolor dolore",
            "condition_type": "enim incididunt nostrud elit"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "officia ullamco nulla elit",
            "value": "consectetur",
            "condition_type": "labore sit ad occaecat velit"
          },
          {
            "field": "veniam nulla",
            "value": "dolore non",
            "condition_type": "dolor id officia"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "aute",
        "direction": "consequat nisi dolore ut"
      },
      {
        "field": "aute",
        "direction": "velit aute fugiat adipisicing in"
      }
    ],
    "page_size": 59190213,
    "current_page": 25831185
  },
  "total_count": -89999765
}

OK

inventory Api Stock Repository V1Save Post

Save Stock data

post

/V1/inventory/stocks

Header parameters

Content-Typestring

Example: application/json

Body

object

Example: {"stock":{"stock_id":-88693904,"name":"est proident ut laboris adipisicing","extension_attributes":{"sales_channels":[{"type":"mollit Ut tempor occaecat","code":"in nisi dolor","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"type":"mollit nostrud","code":"minim sed","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}}}

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/inventory/stocks' \
  --header 'Content-Type: application/json' \
  --data '{
    "stock": {
      "stock_id": -88693904,
      "name": "est proident ut laboris adipisicing",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "mollit Ut tempor occaecat",
            "code": "in nisi dolor",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "mollit nostrud",
            "code": "minim sed",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    }
  }'

200

400

401

500

200

66689314

OK