Sources

inventory Api Source Repository V1Get Get

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

get

/V1/inventory/sources/{sourceCode}

Path parameters

sourceCodestringrequired

(Required)

Example: <string>

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

401

500

{
  "source_code": "aliquip reprehenderit",
  "name": "in est et incididunt",
  "email": "laboris",
  "contact_name": "ut labore dolore",
  "enabled": false,
  "description": "laboris dolore Ut proident pariatur",
  "latitude": 41795452.36343554,
  "longitude": -13541944.906999603,
  "country_id": "reprehenderit dolore et pro",
  "region_id": -67580652,
  "region": "ut ",
  "city": "dolore labore enim",
  "street": "ad aute amet ea",
  "postcode": "sint eu veniam reprehenderit",
  "phone": "veniam eiusmod",
  "fax": "deserunt eiusmod et",
  "use_default_carrier_config": true,
  "carrier_links": [
    {
      "carrier_code": "qui dolor in",
      "position": -70912613,
      "extension_attributes": {}
    },
    {
      "carrier_code": "ex eu",
      "position": -53390341,
      "extension_attributes": {}
    }
  ],
  "extension_attributes": {
    "is_pickup_location_active": true,
    "frontend_name": "exercitation Ut non enim ipsum",
    "frontend_description": "ex sint aute"
  }
}

inventory Api Source Repository V1Save Put

Save Source data

put

/V1/inventory/sources/{sourceCode}

Path parameters

sourceCodestringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"source":{"source_code":"fugiat irure sunt","name":"dolore enim proident","email":"ex","contact_name":"voluptate in","enabled":true,"description":"nisi ut","latitude":-94639462.57247242,"longitude":40313848.06426379,"country_id":"commodo ea","region_id":-15459067,"region":"dolore","city":"esse laborum mollit dolore culpa","street":"non voluptate proident cupida","postcode":"Ut","phone":"laboris non ut","fax":"ut in","use_default_carrier_config":true,"carrier_links":[{"carrier_code":"aliquip pariatur tempor","position":-34309493,"extension_attributes":{}},{"carrier_code":"enim Ut exercitation in cillum","position":88696842,"extension_attributes":{}}],"extension_attributes":{"is_pickup_location_active":false,"frontend_name":"ad reprehenderit in nulla","frontend_description":"in aute do ipsum"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/inventory/sources/{sourceCode}' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "source_code": "fugiat irure sunt",
      "name": "dolore enim proident",
      "email": "ex",
      "contact_name": "voluptate in",
      "enabled": true,
      "description": "nisi ut",
      "latitude": -94639462.57247242,
      "longitude": 40313848.06426379,
      "country_id": "commodo ea",
      "region_id": -15459067,
      "region": "dolore",
      "city": "esse laborum mollit dolore culpa",
      "street": "non voluptate proident cupida",
      "postcode": "Ut",
      "phone": "laboris non ut",
      "fax": "ut in",
      "use_default_carrier_config": true,
      "carrier_links": [
        {
          "carrier_code": "aliquip pariatur tempor",
          "position": -34309493,
          "extension_attributes": {}
        },
        {
          "carrier_code": "enim Ut exercitation in cillum",
          "position": 88696842,
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "is_pickup_location_active": false,
        "frontend_name": "ad reprehenderit in nulla",
        "frontend_description": "in aute do ipsum"
      }
    }
  }'

400

401

500

{
  "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 Source Repository V1Get List Get

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

get

/V1/inventory/sources

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

cURL

JavaScript

Python

HTTP

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

200

401

500

{
  "items": [
    {
      "source_code": "exercitation in",
      "name": "esse aute elit amet",
      "email": "nostrud minim ut est",
      "contact_name": "elit labore eu",
      "enabled": true,
      "description": "ut culpa dolor",
      "latitude": 84534704.80284157,
      "longitude": -91700018.87314893,
      "country_id": "irure aliqua",
      "region_id": 45089800,
      "region": "occaecat dolore eu",
      "city": "aliquip Duis aliqua ea eiu",
      "street": "nostrud esse sit ipsum",
      "postcode": "consequat sit sunt amet",
      "phone": "eiusmod",
      "fax": "anim ut id enim",
      "use_default_carrier_config": false,
      "carrier_links": [
        {
          "carrier_code": "esse ullamco",
          "position": -99698659,
          "extension_attributes": {}
        },
        {
          "carrier_code": "deserunt est",
          "position": -76011908,
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "is_pickup_location_active": false,
        "frontend_name": "officia ad incididunt",
        "frontend_description": "dolore nostrud officia"
      }
    },
    {
      "source_code": "commodo amet ut sed officia",
      "name": "Ut veniam",
      "email": "est enim",
      "contact_name": "irure aute",
      "enabled": true,
      "description": "aute minim",
      "latitude": 91212933.3989284,
      "longitude": 10011210.489502981,
      "country_id": "culpa dolore",
      "region_id": 19275205,
      "region": "commodo magna",
      "city": "",
      "street": "anim occaecat aliquip proident",
      "postcode": "nostrud laborum velit sint commodo",
      "phone": "aliq",
      "fax": "culpa",
      "use_default_carrier_config": true,
      "carrier_links": [
        {
          "carrier_code": "cillum in",
          "position": -96350668,
          "extension_attributes": {}
        },
        {
          "carrier_code": "elit aute quis",
          "position": -56200356,
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "is_pickup_location_active": true,
        "frontend_name": "mollit",
        "frontend_description": "non"
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "elit Lorem qui",
            "value": "exercitation consectetur aliqua",
            "condition_type": "Duis ad voluptate officia"
          },
          {
            "field": "in et id nostrud",
            "value": "ullamco non voluptate esse",
            "condition_type": "cillum laboris aute"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "pariatur",
            "value": "officia",
            "condition_type": "est commodo nostrud"
          },
          {
            "field": "nis",
            "value": "esse nostrud",
            "condition_type": "commodo exercitation Duis enim"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "est consectetur",
        "direction": "sint ad eu"
      },
      {
        "field": "Excepteur Ut velit commodo",
        "direction": "reprehenderit in eu dolore"
      }
    ],
    "page_size": 63833330,
    "current_page": 4142590
  },
  "total_count": -10193774
}

inventory Api Source Repository V1Save Post

Save Source data

post

/V1/inventory/sources

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"source":{"source_code":"fugiat irure sunt","name":"dolore enim proident","email":"ex","contact_name":"voluptate in","enabled":true,"description":"nisi ut","latitude":-94639462.57247242,"longitude":40313848.06426379,"country_id":"commodo ea","region_id":-15459067,"region":"dolore","city":"esse laborum mollit dolore culpa","street":"non voluptate proident cupida","postcode":"Ut","phone":"laboris non ut","fax":"ut in","use_default_carrier_config":true,"carrier_links":[{"carrier_code":"aliquip pariatur tempor","position":-34309493,"extension_attributes":{}},{"carrier_code":"enim Ut exercitation in cillum","position":88696842,"extension_attributes":{}}],"extension_attributes":{"is_pickup_location_active":false,"frontend_name":"ad reprehenderit in nulla","frontend_description":"in aute do ipsum"}}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/inventory/sources' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": {
      "source_code": "fugiat irure sunt",
      "name": "dolore enim proident",
      "email": "ex",
      "contact_name": "voluptate in",
      "enabled": true,
      "description": "nisi ut",
      "latitude": -94639462.57247242,
      "longitude": 40313848.06426379,
      "country_id": "commodo ea",
      "region_id": -15459067,
      "region": "dolore",
      "city": "esse laborum mollit dolore culpa",
      "street": "non voluptate proident cupida",
      "postcode": "Ut",
      "phone": "laboris non ut",
      "fax": "ut in",
      "use_default_carrier_config": true,
      "carrier_links": [
        {
          "carrier_code": "aliquip pariatur tempor",
          "position": -34309493,
          "extension_attributes": {}
        },
        {
          "carrier_code": "enim Ut exercitation in cillum",
          "position": 88696842,
          "extension_attributes": {}
        }
      ],
      "extension_attributes": {
        "is_pickup_location_active": false,
        "frontend_name": "ad reprehenderit in nulla",
        "frontend_description": "in aute do ipsum"
      }
    }
  }'

400

401

500

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