ReDoc documentation

inventory/stocks/{stockId}

inventory/stocks/{stockId}

get/V1/inventory/stocks/{stockId}

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

Request
path Parameters
stockId
required
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "stock_id": 0,
  • "name": "string",
  • "extension_attributes": {
    }
}

inventory/stocks/{stockId}

delete/V1/inventory/stocks/{stockId}

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

Request
path Parameters
stockId
required
integer
Responses
400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "message": "string",
  • "errors": [
    ],
  • "code": 0,
  • "parameters": [
    ],
  • "trace": "string"
}

inventory/stocks/{stockId}

put/V1/inventory/stocks/{stockId}

Save Stock data

Request
path Parameters
stockId
required
string
Request Body schema:
required
object (inventory-api-data-stock-interface)

Represents product aggregation among some different physical storages (in technical words, it is an index) Used fully qualified namespaces in annotations for proper work of WebApi request parser

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "stock": {
    }
}
Response samples
0
0
➔ Next to invoice/{invoiceId}/refund