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

Stocks

PreviousSourcesNextStock source links

inventory Api Stock Repository V1Delete By Id Delete

delete

Delete the Stock data by stockId. If stock is not found do nothing

Path parameters
stockIdstringRequired

(Required)

Example: <integer>
Responses
400
Bad Request
application/json
Responseobject
401
Unauthorized
application/json
500
Internal Server Error
application/json
delete
DELETE /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "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 Stock Repository V1Get List Get

get

Find Stocks by given 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
GET /V1/inventory/stocks HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "stock_id": 1959978,
      "name": "Excepteur",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "reprehenderit",
            "code": "proident Duis fugiat",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "minim voluptate ",
            "code": "Duis commodo dolore consequat",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    },
    {
      "stock_id": 16437491,
      "name": "non in est",
      "extension_attributes": {
        "sales_channels": [
          {
            "type": "Lorem minim incididunt",
            "code": "in cupidatat est",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "type": "in Duis Lorem",
            "code": "sunt Ut adipisicing deserunt",
            "extension_attributes": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      }
    }
  ],
  "search_criteria": {
    "filter_groups": [
      {
        "filters": [
          {
            "field": "Excepteur amet",
            "value": "nulla consequat ut laborum in",
            "condition_type": "sit"
          },
          {
            "field": "dolore labore",
            "value": "occaecat culpa sint dolor dolore",
            "condition_type": "enim incididunt nostrud elit"
          }
        ]
      },
      {
        "filters": [
          {
            "field": "officia ullamco nulla elit",
            "value": "consectetur",
            "condition_type": "labore sit ad occaecat velit"
          },
          {
            "field": "veniam nulla",
            "value": "dolore non",
            "condition_type": "dolor id officia"
          }
        ]
      }
    ],
    "sort_orders": [
      {
        "field": "aute",
        "direction": "consequat nisi dolore ut"
      },
      {
        "field": "aute",
        "direction": "velit aute fugiat adipisicing in"
      }
    ],
    "page_size": 59190213,
    "current_page": 25831185
  },
  "total_count": -89999765
}
  • GETinventory Api Stock Repository V1Get Get
  • PUTinventory Api Stock Repository V1Save Put
  • DELETEinventory Api Stock Repository V1Delete By Id Delete
  • GETinventory Api Stock Repository V1Get List Get
  • POSTinventory Api Stock Repository V1Save Post

inventory Api Stock Repository V1Get Get

get

Get Stock data by given stockId. 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
stockIdstringRequired

(Required)

Example: <integer>
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
get
GET /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "stock_id": 4692958,
  "name": "reprehenderit consequat",
  "extension_attributes": {
    "sales_channels": [
      {
        "type": "sit incididunt nulla consectetur",
        "code": "id",
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      },
      {
        "type": "do reprehenderit ea",
        "code": "aliquip elit Excepteur",
        "extension_attributes": {
          "value": "<Error: Too many levels of nesting to fake this schema>"
        }
      }
    ]
  }
}

inventory Api Stock Repository V1Save Put

put

Save Stock data

Path parameters
stockIdstringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"stock":{"stock_id":-88693904,"name":"est proident ut laboris adipisicing","extension_attributes":{"sales_channels":[{"type":"mollit Ut tempor occaecat","code":"in nisi dolor","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"type":"mollit nostrud","code":"minim sed","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
put
PUT /V1/inventory/stocks/{stockId} HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "stock": {
    "stock_id": -88693904,
    "name": "est proident ut laboris adipisicing",
    "extension_attributes": {
      "sales_channels": [
        {
          "type": "mollit Ut tempor occaecat",
          "code": "in nisi dolor",
          "extension_attributes": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "type": "mollit nostrud",
          "code": "minim sed",
          "extension_attributes": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  }
}
66689314

inventory Api Stock Repository V1Save Post

post

Save Stock data

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"stock":{"stock_id":-88693904,"name":"est proident ut laboris adipisicing","extension_attributes":{"sales_channels":[{"type":"mollit Ut tempor occaecat","code":"in nisi dolor","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}},{"type":"mollit nostrud","code":"minim sed","extension_attributes":{"value":"<Error: Too many levels of nesting to fake this schema>"}}]}}}
Responses
200
OK
application/json
Responseobject
400
Bad Request
application/json
401
Unauthorized
application/json
500
Internal Server Error
application/json
post
POST /V1/inventory/stocks HTTP/1.1
Host: {{baseurl}}
Content-Type: application/json
Accept: */*
Content-Length: 408

{
  "stock": {
    "stock_id": -88693904,
    "name": "est proident ut laboris adipisicing",
    "extension_attributes": {
      "sales_channels": [
        {
          "type": "mollit Ut tempor occaecat",
          "code": "in nisi dolor",
          "extension_attributes": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        },
        {
          "type": "mollit nostrud",
          "code": "minim sed",
          "extension_attributes": {
            "value": "<Error: Too many levels of nesting to fake this schema>"
          }
        }
      ]
    }
  }
}
66689314