Sources

inventory Api Source Repository V1Get Get

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

Path parameters

sourceCodestringRequired

(Required)

Example: <string>

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/sources/{sourceCode} HTTP/1.1
Host: {{baseurl}}
Accept: */*

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

put

Save Source data

Path parameters

sourceCodestringRequired

(Required)

Example: <string>

Header parameters

Content-TypestringOptionalExample: application/json

Body

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

400

Bad Request

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

put

HTTPcURLJavaScriptPython

PUT /V1/inventory/sources/{sourceCode} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 805

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

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

get

Find Sources by 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/sources HTTP/1.1
Host: {{baseurl}}
Accept: */*

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

post

Save Source data

Header parameters

Content-TypestringOptionalExample: application/json

Body

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

400

Bad Request

application/json

Responseobject

401

Unauthorized

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

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

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

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