Maginium
Admin Api
Admin Api
  • About
  • API reference
    • CustomerGroups
      • Permissions
      • Default
      • Search
    • Customers
      • Confirm
      • BillingAddress
      • ShippingAddress
      • Carts
      • Me
        • Activate
        • Password
        • BillingAddress
        • ShippingAddress
      • Search
      • Activate
      • Password
        • ResetLinkToken
      • ResetPassword
      • Validate
      • IsEmailAvailable
      • Addresses
      • Permissions
        • Readonly
    • CmsPage
      • Search
    • CmsBlock
      • Search
    • Products
      • Media
        • Types
      • Options
        • Types
      • Links
        • Types
        • Attributes
      • Websites
      • Downloadable links
        • Samples
      • Attributes
        • Options
        • Types
      • Attribute sets
        • Attributes
        • Groups
          • List
        • Sets
          • List
      • Tier prices
      • Types
      • Tier prices information
      • Tier prices delete
      • Base prices information
      • Base prices
      • Cost information
      • Cost
      • Cost delete
      • Special price information
      • Special price
      • Special price delete
      • StockItems
      • Group prices
        • Tiers
          • Price
    • Categories
      • Attributes
        • Options
      • Products
      • Move
      • List
    • StockItems
      • LowStock
        • /
    • Carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods by address id
      • Estimate shipping methods
      • Payment methods
      • Totals
      • Shipping information
      • Totals information
      • Mine
        • Items
        • Selected payment method
        • Billing address
        • Coupons
        • Payment information
        • Gift message
        • Order
        • Shipping methods
        • Estimate shipping methods by address id
        • Estimate shipping methods
        • Payment methods
        • Totals
        • Collect totals
        • Shipping information
        • Totals information
        • Set payment information
      • Licence
        • List
      • /
      • Search
    • Guest carts
      • Items
      • Selected payment method
      • Billing address
      • Coupons
      • Payment information
      • Gift message
      • Order
      • Shipping methods
      • Estimate shipping methods
      • Payment methods
      • Collect totals
      • Totals
      • Shipping information
      • Totals information
      • Set payment information
    • Orders
      • Comments
      • Statuses
      • Cancel
      • Emails
      • Hold
      • Unhold
      • Items
      • Create
    • Invoices
      • Comments
      • Emails
      • Void
      • Capture
      • /
    • Creditmemo
      • Comments
      • Emails
      • Refund
    • Shipment
      • Comments
      • Emails
      • Label
      • Track
      • /
    • Transactions
    • TaxRates
      • Search
    • TaxRules
      • Search
    • TaxClasses
      • Search
    • SalesRules
      • Search
    • Coupons
      • Search
      • Generate
      • DeleteByIds
      • DeleteByCodes
    • Bulk
      • Detailed status
      • Status
      • Operation status
    • Modules
    • Search
    • Addresses
    • Products render info
    • StockStatuses
    • Creditmemos
    • Shipments
    • Amazon shipping address
    • Amazon billing address
    • Store
      • StoreViews
      • StoreGroups
      • Websites
      • StoreConfigs
    • Adobestock
      • Asset
        • Search
        • List
      • Search
    • Directory
      • Countries
      • Currency
    • Eav
      • Attribute sets
        • List
    • AttributeMetadata
      • Customer
        • Attribute
        • Form
        • Custom
      • CustomerAddress
        • Attribute
        • Form
        • Custom
    • Bundle products
      • Links
      • Options
        • Children
        • All
        • Types
        • Add
      • Children
    • Order
      • Refund
      • Ship
      • Invoice
      • Notify orders are ready for pickup
    • Configurable products
      • Children
      • Options
        • All
      • Child
      • Variation
    • Inventory
      • Sources
      • Stocks
      • Stock source links
      • Source items
      • Low quantity notification
      • Get sources assigned to stock ordered by priority
      • Stock source links delete
      • Source items delete
      • Bulk product source assign
      • Bulk product source unassign
      • Bulk product source transfer
      • Bulk partial source transfer
      • Get distance provider code
      • Get distance
      • Get latlng from address
      • Get latslngs from address
      • Export stock salable qty
      • Dump stock index data
      • Get product salable quantity
      • Is product salable
      • Are products salable
      • Is product salable for requested qty
      • Stock resolver
      • Source selection algorithm list
      • Source selection algorithm result
      • Low quantity notifications delete
      • Are product salable for requested qty
        • /
      • In store pickup
        • Pickup locations
          • /
    • Invoice
      • Refund
    • Analytics
      • Link
    • Amazon
      • Order ref
    • Applepay
      • Auth
    • Address
      • Cleanse
    • Guest address
      • Cleanse
    • Vertex address validation
      • Vertex address
    • Integration
      • Admin
        • Token
      • Customer
        • Token
Powered by GitBook
On this page
  1. API reference
  2. Inventory

Source items

PreviousStock source linksNextLow quantity notification
  • GETinventory Api Source Item Repository V1Get List Get
  • POSTinventory Api Source Items Save V1Execute Post

inventory Api Source Item Repository V1Get List Get

get

Find SourceItems by SearchCriteria We need to have this method for direct work with SourceItems because this object contains additional data like as qty, status (for example can be searchable by additional field)

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
GET /V1/inventory/source-items HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "sku": "velit",
      "source_code": "pariatur fugiat proident dolor",
      "quantity": -20640017.673240468,
      "status": 90802998,
      "extension_attributes": {}
    },
    {
      "sku": "sed ad",
      "source_code": "sed enim",
      "quantity": 65710480.62986055,
      "status": -5162277,
      "extension_attributes": {}
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "qui Excepteur elit",
            "value": "cillum in Excepteur anim",
            "condition_type": "Lorem "
          },
          {
            "field": "fugiat ut est deserunt",
            "value": "eiusmod nostrud",
            "condition_type": "dolo"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "dolore anim ut",
            "value": "quis occaecat Duis aliqua magna",
            "condition_type": "mollit proident"
          },
          {
            "field": "nostrud dolor",
            "value": "irure labore qui dolore",
            "condition_type": "nisi aliqua reprehenderit"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "incididunt consectetur",
        "direction": "elit officia mollit"
      },
      {
        "field": "labore magna mollit",
        "direction": "laboris adipisicing in proident"
      }
    ],
    "page_size": -59427428,
    "current_page": -9737807
  },
  "total_count": -68242363
}

inventory Api Source Items Save V1Execute Post

post

Save Multiple Source item data

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"sourceItems":[{"sku":"ex id","source_code":"dolor tempor","quantity":30822236.37637709,"status":-57093104,"extension_attributes":{}},{"sku":"nulla culpa labore","source_code":"veniam in","quantity":57558935.72801617,"status":-43816670,"extension_attributes":{}}]}
Responses
400
Bad Request
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/inventory/source-items HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 265

{
  "sourceItems": [
    {
      "sku": "ex id",
      "source_code": "dolor tempor",
      "quantity": 30822236.37637709,
      "status": -57093104,
      "extension_attributes": {}
    },
    {
      "sku": "nulla culpa labore",
      "source_code": "veniam in",
      "quantity": 57558935.72801617,
      "status": -43816670,
      "extension_attributes": {}
    }
  ]
}
{
  "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"
}