MageSmith
POSTInventoryApi · Magento 2.4.9 Admin · Magento_InventoryApi::source_edit

POST /V1/inventory/sources

POST /V1/inventory/sources is a Magento 2 REST endpoint in the InventoryApi module. Save Source data. Requires an admin Bearer token with ACL Magento_InventoryApi::source_edit.

Last verified: against Magento 2.4.9.

Returns

void

Service contract

Magento\InventoryApi\Api\SourceRepositoryInterface::save

Authorization

Admin Bearer token with ACL:

  • Magento_InventoryApi::source_edit

Body parameters

source Magento\InventoryApi\Api\Data\SourceInterface Required

Example request

Auto-generated from the service contract — paste-ready against your store's /rest/default base. Replace the host, store code, ACL token, and any required values before running.

Headers

Accept
application/json
Content-Type
application/json
Authorization
Bearer <ACCESS_TOKEN> admin token with ACL: Magento_InventoryApi::source_edit

Path

/V1/inventory/sources

Body

{
  "source": {
    "carrier_links": [
      {
        "carrier_code": "",
        "extension_attributes": {},
        "position": 0
      }
    ],
    "city": "",
    "contact_name": "",
    "country_id": "",
    "description": "",
    "email": "",
    "enabled": false,
    "extension_attributes": {},
    "fax": "",
    "latitude": 0,
    "longitude": 0,
    "name": "",
    "phone": "",
    "postcode": "",
    "region": "",
    "region_id": 0,
    "source_code": "",
    "street": "",
    "use_default_carrier_config": false
  }
}

Related in InventoryApi

Other endpoints shipped by the same module.

GET

/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stockId

Get Sources assigned to Stock ordered by priority

InventoryApi · Magento\InventoryApi\Api\GetSourcesAssignedToStockOrderedByPriorityInterface::execute

→
GET

/V1/inventory/source-items

Find SourceItems by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceItemRepositoryInterface::getList

→
POST

/V1/inventory/source-items

Save Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsSaveInterface::execute

→
POST

/V1/inventory/source-items-delete

Delete Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsDeleteInterface::execute

→
GET

/V1/inventory/sources

Find Sources by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::getList

→
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

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::get

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →