Stocks

inventory Api Stock Repository V1Get Get

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

Path parameters

stockIdstringRequired

(Required)

Example: <integer>

Responses

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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>"
        }
      }
    ]
  }
}

inventory Api Stock Repository V1Save Put

put

Save Stock data

Path parameters

stockIdstringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"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

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "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>"
          }
        }
      ]
    }
  }
}

66689314

inventory Api Stock Repository V1Delete By Id Delete

delete

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

Path parameters

stockIdstringRequired

(Required)

Example: <integer>

Responses

400

Bad Request

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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"
}

inventory Api Stock Repository V1Get List Get

get

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

Query parameters

searchCriteria[filterGroups][0][filters][0][field]stringOptional

Field

Example: <string>

searchCriteria[filterGroups][0][filters][0][value]stringOptional

Value

Example: <string>

searchCriteria[filterGroups][0][filters][0][conditionType]stringOptional

Condition type

Example: <string>

searchCriteria[sortOrders][0][field]stringOptional

Sorting field.

Example: <string>

searchCriteria[sortOrders][0][direction]stringOptional

Sorting direction.

Example: <string>

searchCriteria[pageSize]stringOptional

Page size.

Example: <integer>

searchCriteria[currentPage]stringOptional

Current page.

Example: <integer>

Responses

200

OK

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /V1/inventory/stocks HTTP/1.1
Host: {{baseurl}}
Accept: */*

{
  "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
}

inventory Api Stock Repository V1Save Post

post

Save Stock data

Header parameters

Content-TypestringOptionalExample: application/json

Body

application/json

objectOptionalExample: {"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

200

OK

application/json

Responseobject

400

Bad Request

application/json

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /V1/inventory/stocks HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "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>"
          }
        }
      ]
    }
  }
}

66689314