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
  3. In store pickup
  4. Pickup locations

/

PreviousPickup locationsNextInvoice

inventory In Store Pickup Api Get Pickup Locations V1Execute Get

get

Get Pickup Locations according to the results of filtration by Search Request.

Query parameters
searchRequest[area][radius]stringOptional

Search radius in KM.

Example: <integer>
searchRequest[area][searchTerm]stringOptional

Search term string.

Example: <string>
searchRequest[filters][country][value]stringOptional

Value.

Example: <string>
searchRequest[filters][country][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][postcode][value]stringOptional

Value.

Example: <string>
searchRequest[filters][postcode][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][region][value]stringOptional

Value.

Example: <string>
searchRequest[filters][region][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][regionId][value]stringOptional

Value.

Example: <string>
searchRequest[filters][regionId][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][city][value]stringOptional

Value.

Example: <string>
searchRequest[filters][city][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][street][value]stringOptional

Value.

Example: <string>
searchRequest[filters][street][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][name][value]stringOptional

Value.

Example: <string>
searchRequest[filters][name][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[filters][pickupLocationCode][value]stringOptional

Value.

Example: <string>
searchRequest[filters][pickupLocationCode][conditionType]stringOptional

Condition Type.

Example: <string>
searchRequest[pageSize]stringOptional

Page size.

Example: <integer>
searchRequest[currentPage]stringOptional

Current page.

Example: <integer>
searchRequest[scopeType]stringOptional

Sales Channel Type.

Example: <string>
searchRequest[scopeCode]stringOptional

Sales Channel code.

Example: <string>
searchRequest[sort][0][field]stringOptional

Sorting field.

Example: <string>
searchRequest[sort][0][direction]stringOptional

Sorting direction.

Example: <string>
searchRequest[extensionAttributes][productsInfo][0][sku]stringOptional

Product SKU.

Example: <string>
Responses
200
OK
application/json
Responseobject
500
Internal Server Error
application/json
get
GET /V1/inventory/in-store-pickup/pickup-locations/ HTTP/1.1
Host: {{baseurl}}
Accept: */*
{
  "items": [
    {
      "pickup_location_code": "ullamco officia laboris ex",
      "name": "eiusmod enim Lorem dolore",
      "email": "et non",
      "fax": "laboris eiusmod",
      "contact_name": "magna reprehenderit",
      "description": "dolor c",
      "latitude": -95102367.7620761,
      "longitude": 70884837.896965,
      "country_id": "irure",
      "region_id": -48601991,
      "region": "reprehe",
      "city": "velit in ex dolor sed",
      "street": "minim",
      "postcode": "exercitation U",
      "phone": "dolor Excepteur",
      "extension_attributes": {}
    },
    {
      "pickup_location_code": "magna amet occaecat",
      "name": "nulla",
      "email": "nostrud dolor officia Excepteur",
      "fax": "esse dolore",
      "contact_name": "in ipsum minim in",
      "description": "dolor fugiat irure",
      "latitude": 40734080.88553104,
      "longitude": -77065040.42343001,
      "country_id": "mollit esse",
      "region_id": 14797385,
      "region": "aute",
      "city": "proident dolore",
      "street": "culpa esse labore dolore in",
      "postcode": "dolore quis",
      "phone": "Lorem velit qui",
      "extension_attributes": {}
    }
  ],
  "search_request": {
    "current_page": 64683191,
    "scope_type": "exercitation labore cupidatat sint",
    "scope_code": "aliquip dolor irure elit",
    "area": {
      "radius": -13583933,
      "search_term": "magna eiusmod fugiat"
    },
    "filters": {
      "country": {
        "value": "sit quis",
        "condition_type": "aliquip non"
      },
      "postcode": {
        "value": "aliqua Excepteur sed eiusmod",
        "condition_type": "est sint la"
      },
      "region": {
        "value": "laborum incididunt",
        "condition_type": "fugiat dolore ullamco in"
      },
      "region_id": {
        "value": "incididunt eiusmod",
        "condition_type": "ullamco ex do occaecat"
      },
      "city": {
        "value": "id",
        "condition_type": "magna enim cillum"
      },
      "street": {
        "value": "laborum nisi veniam",
        "condition_type": "cupidatat "
      },
      "name": {
        "value": "id sit proident nulla",
        "condition_type": "do cillum"
      },
      "pickup_location_code": {
        "value": "tempor cillum nul",
        "condition_type": "off"
      }
    },
    "page_size": -54808303,
    "sort": [
      {
        "field": "dolor",
        "direction": "velit nostrud laborum officia"
      },
      {
        "field": "non veniam",
        "direction": "veniam labore"
      }
    ],
    "extension_attributes": {
      "products_info": [
        {
          "sku": "eiusmod aliquip exercitation",
          "extension_attributes": {}
        },
        {
          "sku": "sunt",
          "extension_attributes": {}
        }
      ]
    }
  },
  "total_count": -739231
}