Skip to main content
POST
/
account
/
subscriptions
/
{subscriptionId}
/
shipping
Update shipping options
curl --request POST \
  --url https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shippingOption": "delivery",
  "shippingAddress": "aa11bb22-cc33-dd44-ee55-ff6677889900",
  "pickupLocation": null
}
'
import requests

url = "https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping"

payload = {
"shippingOption": "delivery",
"shippingAddress": "aa11bb22-cc33-dd44-ee55-ff6677889900",
"pickupLocation": None
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
shippingOption: 'delivery',
shippingAddress: 'aa11bb22-cc33-dd44-ee55-ff6677889900',
pickupLocation: null
})
};

fetch('https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping",
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([
'shippingOption' => 'delivery',
'shippingAddress' => 'aa11bb22-cc33-dd44-ee55-ff6677889900',
'pickupLocation' => null
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping"

payload := strings.NewReader("{\n \"shippingOption\": \"delivery\",\n \"shippingAddress\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"pickupLocation\": null\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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))

}
HttpResponse<String> response = Unirest.post("https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"shippingOption\": \"delivery\",\n \"shippingAddress\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"pickupLocation\": null\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.marzipan.co/v1/account/subscriptions/{subscriptionId}/shipping")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"shippingOption\": \"delivery\",\n \"shippingAddress\": \"aa11bb22-cc33-dd44-ee55-ff6677889900\",\n \"pickupLocation\": null\n}"

response = http.request(request)
puts response.read_body
{}
{
"message": "Unauthenticated."
}
{
"message": "Subscription not found"
}
{
"message": "<string>",
"errors": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is the account token returned from the Login endpoint.

Path Parameters

subscriptionId
string<uuid>
required

Subscription ID

Body

application/json
shippingOption
enum<string>
required

Preferred shipping option

Available options:
pickup,
delivery
shippingAddress
string<uuid> | null

Customer address ID. Required when shipping_option is delivery

pickupLocation
string<uuid> | null

Shipping method / pickup location ID. Required when shipping_option is pickup

Response

Shipping options updated

The response is of type object.