Skip to main content
POST
/
subscriptions
/
cp
/
api
/
pickup
/
locations
List available pickup locations
curl --request POST \
  --url https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "cartDiscounts": [
    {}
  ],
  "customer": {
    "displayName": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "get__typename": "<string>",
    "id": "<string>",
    "lastName": "<string>",
    "phone": "<string>"
  },
  "grandTotal": 123,
  "lineItems": [
    {
      "discounts": [
        {}
      ],
      "giftCard": true,
      "hasSellingPlanGroups": true,
      "price": 123,
      "productId": 123,
      "productType": "<string>",
      "properties": {},
      "quantity": 123,
      "requiresSellingPlan": true,
      "sellingPlanId": "<string>",
      "sku": "<string>",
      "taxLines": [
        {}
      ],
      "taxable": true,
      "title": "<string>",
      "uuid": "<string>",
      "variantId": 123,
      "vendor": "<string>"
    }
  ],
  "properties": {},
  "subtotal": 123,
  "taxTotal": 123
}
'
import requests

url = "https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations"

payload = {
"cartDiscounts": [{}],
"customer": {
"displayName": "<string>",
"email": "<string>",
"firstName": "<string>",
"get__typename": "<string>",
"id": "<string>",
"lastName": "<string>",
"phone": "<string>"
},
"grandTotal": 123,
"lineItems": [
{
"discounts": [{}],
"giftCard": True,
"hasSellingPlanGroups": True,
"price": 123,
"productId": 123,
"productType": "<string>",
"properties": {},
"quantity": 123,
"requiresSellingPlan": True,
"sellingPlanId": "<string>",
"sku": "<string>",
"taxLines": [{}],
"taxable": True,
"title": "<string>",
"uuid": "<string>",
"variantId": 123,
"vendor": "<string>"
}
],
"properties": {},
"subtotal": 123,
"taxTotal": 123
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
cartDiscounts: [{}],
customer: {
displayName: '<string>',
email: '<string>',
firstName: '<string>',
get__typename: '<string>',
id: '<string>',
lastName: '<string>',
phone: '<string>'
},
grandTotal: 123,
lineItems: [
{
discounts: [{}],
giftCard: true,
hasSellingPlanGroups: true,
price: 123,
productId: 123,
productType: '<string>',
properties: {},
quantity: 123,
requiresSellingPlan: true,
sellingPlanId: '<string>',
sku: '<string>',
taxLines: [{}],
taxable: true,
title: '<string>',
uuid: '<string>',
variantId: 123,
vendor: '<string>'
}
],
properties: {},
subtotal: 123,
taxTotal: 123
})
};

fetch('https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
const url = 'https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations';
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
cartDiscounts: [{}],
customer: {
displayName: '<string>',
email: '<string>',
firstName: '<string>',
get__typename: '<string>',
id: '<string>',
lastName: '<string>',
phone: '<string>'
},
grandTotal: 123,
lineItems: [
{
discounts: [{}],
giftCard: true,
hasSellingPlanGroups: true,
price: 123,
productId: 123,
productType: '<string>',
properties: {},
quantity: 123,
requiresSellingPlan: true,
sellingPlanId: '<string>',
sku: '<string>',
taxLines: [{}],
taxable: true,
title: '<string>',
uuid: '<string>',
variantId: 123,
vendor: '<string>'
}
],
properties: {},
subtotal: 123,
taxTotal: 123
})
};

fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'cartDiscounts' => [
[

]
],
'customer' => [
'displayName' => '<string>',
'email' => '<string>',
'firstName' => '<string>',
'get__typename' => '<string>',
'id' => '<string>',
'lastName' => '<string>',
'phone' => '<string>'
],
'grandTotal' => 123,
'lineItems' => [
[
'discounts' => [
[

]
],
'giftCard' => true,
'hasSellingPlanGroups' => true,
'price' => 123,
'productId' => 123,
'productType' => '<string>',
'properties' => [

],
'quantity' => 123,
'requiresSellingPlan' => true,
'sellingPlanId' => '<string>',
'sku' => '<string>',
'taxLines' => [
[

]
],
'taxable' => true,
'title' => '<string>',
'uuid' => '<string>',
'variantId' => 123,
'vendor' => '<string>'
]
],
'properties' => [

],
'subtotal' => 123,
'taxTotal' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations"

payload := strings.NewReader("{\n \"cartDiscounts\": [\n {}\n ],\n \"customer\": {\n \"displayName\": \"<string>\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"get__typename\": \"<string>\",\n \"id\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"grandTotal\": 123,\n \"lineItems\": [\n {\n \"discounts\": [\n {}\n ],\n \"giftCard\": true,\n \"hasSellingPlanGroups\": true,\n \"price\": 123,\n \"productId\": 123,\n \"productType\": \"<string>\",\n \"properties\": {},\n \"quantity\": 123,\n \"requiresSellingPlan\": true,\n \"sellingPlanId\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxLines\": [\n {}\n ],\n \"taxable\": true,\n \"title\": \"<string>\",\n \"uuid\": \"<string>\",\n \"variantId\": 123,\n \"vendor\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"subtotal\": 123,\n \"taxTotal\": 123\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
require 'uri'
require 'net/http'

url = URI("https://www.myshop.com/apps/subscriptions/cp/api/pickup/locations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"cartDiscounts\": [\n {}\n ],\n \"customer\": {\n \"displayName\": \"<string>\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"get__typename\": \"<string>\",\n \"id\": \"<string>\",\n \"lastName\": \"<string>\",\n \"phone\": \"<string>\"\n },\n \"grandTotal\": 123,\n \"lineItems\": [\n {\n \"discounts\": [\n {}\n ],\n \"giftCard\": true,\n \"hasSellingPlanGroups\": true,\n \"price\": 123,\n \"productId\": 123,\n \"productType\": \"<string>\",\n \"properties\": {},\n \"quantity\": 123,\n \"requiresSellingPlan\": true,\n \"sellingPlanId\": \"<string>\",\n \"sku\": \"<string>\",\n \"taxLines\": [\n {}\n ],\n \"taxable\": true,\n \"title\": \"<string>\",\n \"uuid\": \"<string>\",\n \"variantId\": 123,\n \"vendor\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"subtotal\": 123,\n \"taxTotal\": 123\n}"

response = http.request(request)
puts response.read_body
{}

Query Parameters

type
string
default:pickup

Body

application/json
cartDiscounts
object[]
customer
object
grandTotal
number
lineItems
object[]
properties
object
subtotal
number
taxTotal
number

Response

200 - application/json

OK

The response is of type object.