13 operations. Every schema and example on this page is generated from the platform contract.
To post: paid posted orders not yet marked posted, soonest post-by date first, with Label ready, New address asked for and Late tags. An order refunded or disputed before posting is not on it (rule 41). Posted: by the day each went. Rows carry the buyer’s name, town and postcode, never the street (rule 50).
Store to read (also authorises the merchant).
to_post (the default) or posted. Ignored while `q` searches both.
to_postpostedPosted list: posted on or after this day (shop time). Default 30 days back.
Posted list: posted on or before this day (shop time).
Search both lists: the buyer's name or order number as typed, or the recipient's name, the postcode or the tracking number typed whole (rule 51).
Only one drop's posted orders (the drop's prep sheet).
true: only the counts (the Orders tab badge).
truefalsePost is switched on for this shop. Her paid parcels show either way.
Today in the shop's zone.
Parcels to post, whatever state their drop is in.
Posted in the last 30 days.
The buyer's name: the order is named after her (rule 49).
Where it goes, as far as the town. Never the street (rule 50).
letterboxsmall_parcelmedium_parceltracked_48tracked_24A date, YYYY-MM-DD.
to_postpostedThe saved number is Royal Mail’s shape. False: it is shown without Royal Mail’s name.
Posted can be taken back until then (server clock). Null once the buyer has been told.
Two or more of her orders going to one address share this opaque key, so they sit together. Null otherwise.
A tracking number is saved.
The buyer has asked for a new address.
Past its post-by date and not posted.
curl -G "https://www.membber.com/api/v1/post/orders" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/post/orders", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.listPostOrders(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"post_on": true,
"today": "<today>",
"counts": {
"to_post": -9007199254740991,
"posted": -9007199254740991
},
"orders": [
{
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"buyer_name": "<buyer_name>",
"is_gift": true,
"town": "<town>",
"postcode": "EXAMPLE10",
"items": [
{
"name": "Example name",
"quantity": 1,
"size_label": "<size_label>",
"colour_label": "<colour_label>"
}
],
"total_pence": 1500,
"currency": "GBP",
"parcel_kind": "letterbox",
"service": "tracked_48",
"post_by_date": "<post_by_date>",
"paid_at": "<paid_at>",
"batch_drop_id": "63a4cc66-0000-4000-8000-d0c500000063",
"state": "to_post",
"tracking_number": "<tracking_number>",
"tracking_is_royal_mail": true,
"posted_at": "<posted_at>",
"posted_without_tracking": true,
"undo_until": "<undo_until>",
"arrived_at": "<arrived_at>",
"not_arrived_at": "<not_arrived_at>",
"came_back_at": "<came_back_at>",
"address_group": "<address_group>",
"tags": {
"label_ready": true,
"address_asked": true,
"late": true
}
}
]
}Null = "No section".
The section's first item photo.
Shared by every item in it; null when they differ or none is answered.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items in it have different answers.
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
An item with sizes has a number for each size (rule 13).
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items (or sizes) with a letterbox or small parcel answer.
Items (or sizes) with no answer yet: collect only.
Live or scheduled box drops whose box has no answer.
curl -G "https://www.membber.com/api/v1/post/overview" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/post/overview", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getPostOverview(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"sections": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"count": 1,
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"mixed": true,
"items": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"sizes": [
{
"option_id": null,
"label": null,
"answer": null
}
]
}
]
}
],
"can_be_posted": -9007199254740991,
"need_answer": -9007199254740991,
"drops_need_answer": -9007199254740991
}/api/v1/post/parcel2goBehind POST_PARCEL2GO_ENABLED (off: 404). The shop owner only. Parcel2Go is asked to revoke the token (best effort) and Membber deletes its copy whatever Parcel2Go says. A Parcel2Go label choice goes back to unchosen. Answers the labels view.
The shop (also authorises the person).
False while Parcel2Go is off for this shop: no Labels row is shown and nothing below means anything.
The provider in force: her choice while it is still possible, else today's behaviour (royal_mail where Royal Mail labels are on, else own).
parcel2goroyal_mailownWhat she chose; null until she chooses.
parcel2goroyal_mailownRoyal Mail labels can be chosen here (today's POST_LABELS_ENABLED allows it for this shop). False: drawn as Later.
The signed-in person may connect or disconnect Parcel2Go (the shop owner).
sign_in_again: her Parcel2Go sign-in has expired or was withdrawn; she signs in again.
not_connectedconnectedsign_in_againHer Parcel2Go PrePay balance in pence. Null when not connected, or when Parcel2Go could not be asked just now.
Parcel2Go's own page for making a free account.
Parcel2Go's own page for topping up PrePay.
Parcel2Go's perishables rule, asked on Connect before Parcel2Go's sign-in opens when a live item of the shop is perishable or Membber cannot tell (item 2). Null while switched off.
The rule applies. On the Connect step: a live item of this shop is perishable (food, flowers, plants), or Membber cannot tell. On a parcel: it holds something perishable, or Membber cannot tell. She reads these words and ticks the box, before Connect Parcel2Go and before Buy postage for such a parcel, only while her shop has not ticked the words in force (acknowledged_at null): a tick of them stands, a connect after a disconnect included. False: nothing is shown.
The wording version in force. Send it back with her tick.
Draw exactly as sent.
Draw exactly as sent.
The box's words. Draw exactly as sent, beside a box that starts unticked.
When this shop ticked the words in force (ISO), whatever it sells today. Null: not yet, or only older words.
curl -X DELETE "https://www.membber.com/api/v1/post/parcel2go?store_id=6659c139-0000-4000-8000-d0c500000066" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.DELETE("/api/v1/post/parcel2go", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.disconnectParcel2go(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"switched_on": true,
"provider": "parcel2go",
"chosen": "parcel2go",
"royal_mail_offered": true,
"can_connect": true,
"parcel2go": {
"state": "not_connected",
"balance_pence": 1500,
"create_account_url": "https://example.com/image.jpg",
"top_up_url": "https://example.com/image.jpg"
},
"food_rule": {
"applies": true,
"version": 1,
"title": "Morning class",
"body": "<body>",
"tick": "<tick>",
"acknowledged_at": "<acknowledged_at>"
}
}Her choice of label provider, whether her own Parcel2Go account is connected, and her PrePay balance (read from Parcel2Go on the server, held for a minute). Never a token. Behind POST_PARCEL2GO_ENABLED: off, switched_on is false.
The shop (also authorises the person).
False while Parcel2Go is off for this shop: no Labels row is shown and nothing below means anything.
The provider in force: her choice while it is still possible, else today's behaviour (royal_mail where Royal Mail labels are on, else own).
parcel2goroyal_mailownWhat she chose; null until she chooses.
parcel2goroyal_mailownRoyal Mail labels can be chosen here (today's POST_LABELS_ENABLED allows it for this shop). False: drawn as Later.
The signed-in person may connect or disconnect Parcel2Go (the shop owner).
sign_in_again: her Parcel2Go sign-in has expired or was withdrawn; she signs in again.
not_connectedconnectedsign_in_againHer Parcel2Go PrePay balance in pence. Null when not connected, or when Parcel2Go could not be asked just now.
Parcel2Go's own page for making a free account.
Parcel2Go's own page for topping up PrePay.
Parcel2Go's perishables rule, asked on Connect before Parcel2Go's sign-in opens when a live item of the shop is perishable or Membber cannot tell (item 2). Null while switched off.
The rule applies. On the Connect step: a live item of this shop is perishable (food, flowers, plants), or Membber cannot tell. On a parcel: it holds something perishable, or Membber cannot tell. She reads these words and ticks the box, before Connect Parcel2Go and before Buy postage for such a parcel, only while her shop has not ticked the words in force (acknowledged_at null): a tick of them stands, a connect after a disconnect included. False: nothing is shown.
The wording version in force. Send it back with her tick.
Draw exactly as sent.
Draw exactly as sent.
The box's words. Draw exactly as sent, beside a box that starts unticked.
When this shop ticked the words in force (ISO), whatever it sells today. Null: not yet, or only older words.
curl -G "https://www.membber.com/api/v1/post/parcel2go" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/post/parcel2go", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getPostLabelsProvider(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"switched_on": true,
"provider": "parcel2go",
"chosen": "parcel2go",
"royal_mail_offered": true,
"can_connect": true,
"parcel2go": {
"state": "not_connected",
"balance_pence": 1500,
"create_account_url": "https://example.com/image.jpg",
"top_up_url": "https://example.com/image.jpg"
},
"food_rule": {
"applies": true,
"version": 1,
"title": "Morning class",
"body": "<body>",
"tick": "<tick>",
"acknowledged_at": "<acknowledged_at>"
}
}Behind POST_PARCEL2GO_ENABLED (off: 404). The shop owner only (403 OWNER_REQUIRED). A shop with a perishable item (or one Membber cannot read) whose record does not hold the words in force must send her tick of Parcel2Go's perishables rule (food_rule): the record is written in this request, and without it the start is refused (409 FOOD_RULE_NOT_TICKED; 409 FOOD_RULE_CHANGED for older words; 503 FOOD_RULE_NOT_RECORDED). A tick of the words in force already on her record stands, a connect after a disconnect included. Authorization Code with PKCE: sets a 10-minute HttpOnly SameSite=Lax cookie binding this browser and answers Parcel2Go's sign-in URL; Parcel2Go sends her back to finishParcel2goConnection. Also how she signs in again when her sign-in has run out.
The shop (also authorises the person).
Her tick of Parcel2Go's perishables rule, when the read says it applies. A shop with a perishable item (or one Membber cannot read) needs it in this request only when her shop's record does not hold the words in force: a fresh connect, signing in again and a connect after a disconnect alike. Only new words ask again.
food_rule.version from the read: the words her screen showed.
She ticked the box. Only true is accepted: no tick, no field.
The Business app's build, from the iOS app only. Ignored from the web.
Parcel2Go's sign-in page. Send this browser there (the same browser that made this call). One use, 10 minutes.
curl -X POST "https://www.membber.com/api/v1/post/parcel2go" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/post/parcel2go", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.startParcel2goConnection(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"authorize_url": "https://example.com/image.jpg"
}Behind POST_PARCEL2GO_ENABLED (off: 404). parcel2go needs her account connected (409 PARCEL2GO_NOT_CONNECTED); royal_mail only where Royal Mail labels are on for the shop (409 ROYAL_MAIL_LABELS_NOT_AVAILABLE). Recorded on the shop trail.
The shop (also authorises the person).
parcel2go (her own Parcel2Go account and PrePay balance), royal_mail (Membber's Royal Mail account) or own (she buys her own postage and types the tracking number).
parcel2goroyal_mailownFalse while Parcel2Go is off for this shop: no Labels row is shown and nothing below means anything.
The provider in force: her choice while it is still possible, else today's behaviour (royal_mail where Royal Mail labels are on, else own).
parcel2goroyal_mailownWhat she chose; null until she chooses.
parcel2goroyal_mailownRoyal Mail labels can be chosen here (today's POST_LABELS_ENABLED allows it for this shop). False: drawn as Later.
The signed-in person may connect or disconnect Parcel2Go (the shop owner).
sign_in_again: her Parcel2Go sign-in has expired or was withdrawn; she signs in again.
not_connectedconnectedsign_in_againHer Parcel2Go PrePay balance in pence. Null when not connected, or when Parcel2Go could not be asked just now.
Parcel2Go's own page for making a free account.
Parcel2Go's own page for topping up PrePay.
Parcel2Go's perishables rule, asked on Connect before Parcel2Go's sign-in opens when a live item of the shop is perishable or Membber cannot tell (item 2). Null while switched off.
The rule applies. On the Connect step: a live item of this shop is perishable (food, flowers, plants), or Membber cannot tell. On a parcel: it holds something perishable, or Membber cannot tell. She reads these words and ticks the box, before Connect Parcel2Go and before Buy postage for such a parcel, only while her shop has not ticked the words in force (acknowledged_at null): a tick of them stands, a connect after a disconnect included. False: nothing is shown.
The wording version in force. Send it back with her tick.
Draw exactly as sent.
Draw exactly as sent.
The box's words. Draw exactly as sent, beside a box that starts unticked.
When this shop ticked the words in force (ISO), whatever it sells today. Null: not yet, or only older words.
curl -X PUT "https://www.membber.com/api/v1/post/parcel2go" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"provider": "parcel2go"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/post/parcel2go", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
provider: "parcel2go"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.setPostLabelsProvider(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
provider: .parcel2go
))
).ok.body.json
print(response){
"switched_on": true,
"provider": "parcel2go",
"chosen": "parcel2go",
"royal_mail_offered": true,
"can_connect": true,
"parcel2go": {
"state": "not_connected",
"balance_pence": 1500,
"create_account_url": "https://example.com/image.jpg",
"top_up_url": "https://example.com/image.jpg"
},
"food_rule": {
"applies": true,
"version": 1,
"title": "Morning class",
"body": "<body>",
"tick": "<tick>",
"acknowledged_at": "<acknowledged_at>"
}
}Behind POST_PARCEL2GO_ENABLED (off: 404). Opened by her browser, never called by an app: this is the redirect URL registered on Membber's Parcel2Go client. Needs the cookie startParcel2goConnection set in this browser (else invalid, and nothing is exchanged), the state, the 10-minute window and that the person who started it is still the owner. connected: her tokens are stored encrypted on the server, never sent anywhere. Answers 303 to her Delivery screen with ?parcel2go=<result> (the body below is what it would say).
From Parcel2Go.
From Parcel2Go: what startParcel2goConnection put in the sign-in URL.
From Parcel2Go, when she said no ('access_denied').
The one word her Delivery screen is sent back with.
connecteddeniedexpiredinvalidnot_ownerfailedcurl -G "https://www.membber.com/api/v1/post/parcel2go/return"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient();
const { data, error } = await membber.raw.GET("/api/v1/post/parcel2go/return");
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { nil }
)
let response = try await client.api.finishParcel2goConnection().ok.body.json
print(response){
"result": "connected"
}Unposted parcels due to post on those shop-local days, paid or still to pay the shop, and the day keeping them would move them to: what a merchant is shown before she adds days off over them. Read-only. Rows carry the buyer’s name, never an address (rule 50). To move them, save the days off with `parcels_due: move` and the same days as `parcels_due_days` (PATCH /api/v1/fulfilment-schedule) on her own tap. People who may see her To post list only (it names buyers).
Store to read (also authorises the merchant).
The shop-local days her save is about to close, YYYY-MM-DD, comma-separated (up to 370): never a day already closed. The same list goes back with her yes (`parcels_due_days`).
The buyer’s name; empty when not known.
YYYY-MM-DD, the day it is due to post.
Still to pay the shop: cancelling it has nothing to refund.
Paid by card through Membber, so a refund can give it back.
How many of them `parcels_due: move` would move to her next posting day.
YYYY-MM-DD they would be posted, when they share one day. Null when none can move.
How many would keep their day even then (no posting day, or a drop past its limit).
Her words for those that would keep their day, for any surface to show as it is. Null when none would.
curl -G "https://www.membber.com/api/v1/post/parcels-due" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066" \
--data-urlencode "days=<days>"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/post/parcels-due", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066", days: "<days>" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.listParcelsDue(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066", days: "<days>")
).ok.body.json
print(response){
"parcels": [
{
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"name": "Example name",
"post_by_date": "<post_by_date>",
"to_pay": true,
"card_refundable": true
}
],
"moving": -9007199254740991,
"move_to": "<move_to>",
"kept": -9007199254740991,
"kept_message": "Added at the front desk"
}Service, posting days, packing, most parcels a day, gift notes, terms, Membber pause and today's Royal Mail prices.
Store to read (also authorises the merchant).
False while DELIVERY_POST_ENABLED is off, or is 'preview' and this shop is not a test shop on Membber Business's preview list: Post cannot be switched on here.
Post is on for this shop (and not paused by Membber).
Her service; null until she taps one (neither is chosen for her).
tracked_48tracked_240 = Sunday … 6 = Saturday, her calendar. Empty until she picks.
Her optional packing amount per parcel, at most £2. 0 = none.
Most parcels a posting day; null = no limit.
She has ticked the delivery terms.
Membber has paused Post for this shop: buyers do not see it; paid parcels still show.
The signed-in person may switch Post on (the shop owner). Staff are told to ask the owner.
A live item of hers is perishable (food, flowers, plants), or Membber cannot tell: the posting days show the weekend line, the Post sheet shows Royal Mail's food line, and "Royal Mail recommends Tracked 24…" while no service is picked or Tracked 48 is (never on Tracked 24).
Royal Mail's online drop-off prices today, before any packing or fee.
Present only where the shop's medium parcel is on and has a price (DELIVERY_POST_MEDIUM_PARCEL_ENABLED): absent, no medium parcel is offered.
Royal Mail's online drop-off prices today, before any packing or fee.
Present only where the shop's medium parcel is on and has a price (DELIVERY_POST_MEDIUM_PARCEL_ENABLED): absent, no medium parcel is offered.
Her buyers pay the 5% booking fee, so it is inside the postage they see (false at a waived, fixed or stepped shop).
Present only for a shop that buys her postage on her own Parcel2Go: `prices` are then Parcel2Go's prices for the service (a letterbox parcel goes, and is priced, as a small parcel). Absent: Royal Mail's own prices.
parcel2goPresent only where she may choose Medium parcel for an item or a box: the medium parcel is on for her shop and has a price today. The top weight, in kg, of the one weight band a medium parcel is priced at.
curl -G "https://www.membber.com/api/v1/post/settings" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/post/settings", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getPostSettings(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"switched_on": true,
"enabled": true,
"service": "tracked_48",
"posting_days": [
0
],
"packing_pence": 1500,
"max_parcels_per_day": -9007199254740991,
"gift_notes_enabled": true,
"terms_accepted": true,
"paused_by_membber": true,
"can_switch_on": true,
"perishable": true,
"prices": {
"tracked_48": {
"letterbox_pence": 1500,
"small_parcel_pence": 1500,
"medium_parcel_pence": 1500
},
"tracked_24": {
"letterbox_pence": 1500,
"small_parcel_pence": 1500,
"medium_parcel_pence": 1500
}
},
"fee_on_postage": true,
"prices_from": "parcel2go",
"medium_parcel_up_to_kg": -9007199254740991
}Recorded on the shop trail. 403 POST_OWNER_ONLY when staff try to switch Post on. 409 POST_NOT_SWITCHED_ON while DELIVERY_POST_ENABLED is off; 409 POST_PAUSED when Membber has paused Post; 422 POST_NEEDS_SETUP when switching on without a service, a posting day or the tick; 422 POST_NEEDS_ADDRESS when switching on while her shop address has no full UK postcode (it is every parcel's return address). Idempotent.
Store to change (also authorises the merchant).
Switch Post on or off. On needs the owner, a service, a posting day and the tick.
Royal Mail Tracked 48 (2 to 3 days) or Tracked 24 (next day).
tracked_48tracked_24She ticked the delivery terms. Recorded with who and when.
False while DELIVERY_POST_ENABLED is off, or is 'preview' and this shop is not a test shop on Membber Business's preview list: Post cannot be switched on here.
Post is on for this shop (and not paused by Membber).
Her service; null until she taps one (neither is chosen for her).
tracked_48tracked_240 = Sunday … 6 = Saturday, her calendar. Empty until she picks.
Her optional packing amount per parcel, at most £2. 0 = none.
Most parcels a posting day; null = no limit.
She has ticked the delivery terms.
Membber has paused Post for this shop: buyers do not see it; paid parcels still show.
The signed-in person may switch Post on (the shop owner). Staff are told to ask the owner.
A live item of hers is perishable (food, flowers, plants), or Membber cannot tell: the posting days show the weekend line, the Post sheet shows Royal Mail's food line, and "Royal Mail recommends Tracked 24…" while no service is picked or Tracked 48 is (never on Tracked 24).
Royal Mail's online drop-off prices today, before any packing or fee.
Present only where the shop's medium parcel is on and has a price (DELIVERY_POST_MEDIUM_PARCEL_ENABLED): absent, no medium parcel is offered.
Royal Mail's online drop-off prices today, before any packing or fee.
Present only where the shop's medium parcel is on and has a price (DELIVERY_POST_MEDIUM_PARCEL_ENABLED): absent, no medium parcel is offered.
Her buyers pay the 5% booking fee, so it is inside the postage they see (false at a waived, fixed or stepped shop).
Present only for a shop that buys her postage on her own Parcel2Go: `prices` are then Parcel2Go's prices for the service (a letterbox parcel goes, and is priced, as a small parcel). Absent: Royal Mail's own prices.
parcel2goPresent only where she may choose Medium parcel for an item or a box: the medium parcel is on for her shop and has a price today. The top weight, in kg, of the one weight band a medium parcel is priced at.
curl -X PUT "https://www.membber.com/api/v1/post/settings" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/post/settings", {
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.setPostSettings(
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"switched_on": true,
"enabled": true,
"service": "tracked_48",
"posting_days": [
0
],
"packing_pence": 1500,
"max_parcels_per_day": -9007199254740991,
"gift_notes_enabled": true,
"terms_accepted": true,
"paused_by_membber": true,
"can_switch_on": true,
"perishable": true,
"prices": {
"tracked_48": {
"letterbox_pence": 1500,
"small_parcel_pence": 1500,
"medium_parcel_pence": 1500
},
"tracked_24": {
"letterbox_pence": 1500,
"small_parcel_pence": 1500,
"medium_parcel_pence": 1500
}
},
"fee_on_postage": true,
"prices_from": "parcel2go",
"medium_parcel_up_to_kg": -9007199254740991
}/api/v1/post/travel/itemNull = "No section".
The section's first item photo.
Shared by every item in it; null when they differ or none is answered.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items in it have different answers.
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
An item with sizes has a number for each size (rule 13).
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items (or sizes) with a letterbox or small parcel answer.
Items (or sizes) with no answer yet: collect only.
Live or scheduled box drops whose box has no answer.
curl -X DELETE "https://www.membber.com/api/v1/post/travel/item?store_id=6659c139-0000-4000-8000-d0c500000066&item_id=7e22b9c7-0000-4000-8000-d0c50000007e" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.DELETE("/api/v1/post/travel/item", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066", item_id: "7e22b9c7-0000-4000-8000-d0c50000007e" } },
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.clearPostItemTravel(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066", itemId: "7e22b9c7-0000-4000-8000-d0c50000007e")
).ok.body.json
print(response){
"sections": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"count": 1,
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"mixed": true,
"items": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"sizes": [
{
"option_id": null,
"label": null,
"answer": null
}
]
}
]
}
],
"can_be_posted": -9007199254740991,
"need_answer": -9007199254740991,
"drops_need_answer": -9007199254740991
}Recorded on the shop trail. 404 ITEM_NOT_FOUND for an item of another shop. Idempotent.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotRequired for letterbox, small_parcel and medium_parcel; must be null for cannot (422 POST_TRAVEL_NUMBER).
One size of the item; omitted for the item itself.
Null = "No section".
The section's first item photo.
Shared by every item in it; null when they differ or none is answered.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items in it have different answers.
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
An item with sizes has a number for each size (rule 13).
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items (or sizes) with a letterbox or small parcel answer.
Items (or sizes) with no answer yet: collect only.
Live or scheduled box drops whose box has no answer.
curl -X PUT "https://www.membber.com/api/v1/post/travel/item" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"kind": "letterbox",
"fit_count": 1,
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"item_id": "7e22b9c7-0000-4000-8000-d0c50000007e"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/post/travel/item", {
body: {
kind: "letterbox",
fit_count: 1,
store_id: "6659c139-0000-4000-8000-d0c500000066",
item_id: "7e22b9c7-0000-4000-8000-d0c50000007e"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.setPostItemTravel(
body: .json(.init(
kind: .letterbox,
fitCount: 1,
storeId: "6659c139-0000-4000-8000-d0c500000066",
itemId: "7e22b9c7-0000-4000-8000-d0c50000007e"
))
).ok.body.json
print(response){
"sections": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"count": 1,
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"mixed": true,
"items": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"sizes": [
{
"option_id": null,
"label": null,
"answer": null
}
]
}
]
}
],
"can_be_posted": -9007199254740991,
"need_answer": -9007199254740991,
"drops_need_answer": -9007199254740991
}Recorded on the shop trail with who and how. A change only touches new orders. Idempotent.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotRequired for letterbox, small_parcel and medium_parcel; must be null for cannot (422 POST_TRAVEL_NUMBER).
The section, or null for the items in no section.
Items she changed on their own from this section's sheet: their answers (and their sizes') are kept, never written over.
Null = "No section".
The section's first item photo.
Shared by every item in it; null when they differ or none is answered.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items in it have different answers.
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
An item with sizes has a number for each size (rule 13).
Her answer. Absent (null) = no answer yet: collect only.
letterbox (thinner than 2.5 cm, no bigger than a magazine, under 750 g), small_parcel (a shoebox or smaller, under 2 kg), medium_parcel (a big box, up to 10 kg, only where the shop's medium parcel is on and priced: 409 POST_MEDIUM_NOT_AVAILABLE otherwise) or cannot (collect only).
letterboxsmall_parcelmedium_parcelcannotHow many fit in one letterbox box or one small parcel. Null for cannot.
Items (or sizes) with a letterbox or small parcel answer.
Items (or sizes) with no answer yet: collect only.
Live or scheduled box drops whose box has no answer.
curl -X PUT "https://www.membber.com/api/v1/post/travel/section" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"kind": "letterbox",
"fit_count": 1,
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"section_id": "19e14cb5-0000-4000-8000-d0c500000019"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/post/travel/section", {
body: {
kind: "letterbox",
fit_count: 1,
store_id: "6659c139-0000-4000-8000-d0c500000066",
section_id: "19e14cb5-0000-4000-8000-d0c500000019"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.setPostSectionTravel(
body: .json(.init(
kind: .letterbox,
fitCount: 1,
storeId: "6659c139-0000-4000-8000-d0c500000066",
sectionId: "19e14cb5-0000-4000-8000-d0c500000019"
))
).ok.body.json
print(response){
"sections": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"count": 1,
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"mixed": true,
"items": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"name": "Example name",
"photo_url": "https://example.com/image.jpg",
"answer": {
"kind": "letterbox",
"fit_count": 1
},
"sizes": [
{
"option_id": null,
"label": null,
"answer": null
}
]
}
]
}
],
"can_be_posted": -9007199254740991,
"need_answer": -9007199254740991,
"drops_need_answer": -9007199254740991
}