ReDoc documentation

inventory/sources/{sourceCode}

inventory/sources/{sourceCode}

get/V1/inventory/sources/{sourceCode}

Get Source data by given code. 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
sourceCode
required
string
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Response samples
{
  • "source_code": "string",
  • "name": "string",
  • "email": "string",
  • "contact_name": "string",
  • "enabled": true,
  • "description": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "country_id": "string",
  • "region_id": 0,
  • "region": "string",
  • "city": "string",
  • "street": "string",
  • "postcode": "string",
  • "phone": "string",
  • "fax": "string",
  • "use_default_carrier_config": true,
  • "carrier_links": [
    ],
  • "extension_attributes": {
    }
}

inventory/sources/{sourceCode}

put/V1/inventory/sources/{sourceCode}

Save Source data

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

Represents physical storage, i.e. brick and mortar store or warehouse Used fully qualified namespaces in annotations for proper work of WebApi request parser

Responses
400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

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