13 operations. Every schema and example on this page is generated from the platform contract.
Internal-admin. Every open Royal Mail correction raised against a shop, and the most recently settled.
POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.
Open charges, oldest first, then the most recently settled (at most 50).
The label this charge is for, by the reference Membber sent Royal Mail.
size_or_weightbanned_goodscancel_not_creditedotherWhat is still open: amount less recovered while owed, 0 once settled.
owedrecoveredwaivedThe line on Royal Mail's bill.
Everything open, across shops.
curl -G "https://www.membber.com/api/v1/admin-post/charges" \
-H "Authorization: Bearer $MEMBBER_TOKEN"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-post/charges");
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.adminPostCharges().ok.body.json
print(response){
"switched_on": true,
"charges": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"our_reference": "<our_reference>",
"reason": "size_or_weight",
"amount_pence": 1500,
"recovered_pence": 1500,
"owed_pence": 1500,
"status": "owed",
"carrier_ref": "<carrier_ref>",
"note": "Added at the front desk",
"raised_at": "<raised_at>",
"settled_at": "<settled_at>",
"waived_reason": "Added at the front desk"
}
],
"owed_pence": 1500
}Internal-admin. Refused while POST_LABEL_CORRECTIONS_ENABLED is off, for a label Membber did not buy, above the ceiling, and for a cancelled label whose label money Membber already kept. The same label, reason and bill line raised again answers the first charge: never a second. Moves no money. Audited.
The label's reference as it is on Royal Mail's bill (FLOU-7K2M4D-1).
size_or_weightbanned_goodscancel_not_creditedotherWhat Royal Mail charged Membber for this correction, whole pence, from the bill. Never more.
The line on Royal Mail's bill (invoice and line). One charge per label, reason and line.
POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.
Open charges, oldest first, then the most recently settled (at most 50).
The label this charge is for, by the reference Membber sent Royal Mail.
size_or_weightbanned_goodscancel_not_creditedotherWhat is still open: amount less recovered while owed, 0 once settled.
owedrecoveredwaivedThe line on Royal Mail's bill.
Everything open, across shops.
curl -X POST "https://www.membber.com/api/v1/admin-post/charges" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"our_reference": "<our_reference>",
"reason": "size_or_weight",
"amount_pence": 1500,
"carrier_ref": "<carrier_ref>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/charges", {
body: {
our_reference: "<our_reference>",
reason: "size_or_weight",
amount_pence: 1500,
carrier_ref: "<carrier_ref>"
},
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.adminPostChargeRaise(
body: .json(.init(
ourReference: "<our_reference>",
reason: .sizeOrWeight,
amountPence: 1500,
carrierRef: "<carrier_ref>"
))
).ok.body.json
print(response){
"switched_on": true,
"charges": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"our_reference": "<our_reference>",
"reason": "size_or_weight",
"amount_pence": 1500,
"recovered_pence": 1500,
"owed_pence": 1500,
"status": "owed",
"carrier_ref": "<carrier_ref>",
"note": "Added at the front desk",
"raised_at": "<raised_at>",
"settled_at": "<settled_at>",
"waived_reason": "Added at the front desk"
}
],
"owed_pence": 1500
}Internal-admin. Sets the total paid so far (so saying it twice changes nothing); paid in full closes the charge. Records money Membber already received: it takes nothing. Audited.
What she has paid Membber towards this charge IN ALL, whole pence. Never less than recorded, never more than the charge.
POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.
Open charges, oldest first, then the most recently settled (at most 50).
The label this charge is for, by the reference Membber sent Royal Mail.
size_or_weightbanned_goodscancel_not_creditedotherWhat is still open: amount less recovered while owed, 0 once settled.
owedrecoveredwaivedThe line on Royal Mail's bill.
Everything open, across shops.
curl -X POST "https://www.membber.com/api/v1/admin-post/charges/55994eef-0000-4000-8000-d0c500000055/paid" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"recovered_pence": 1500
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/charges/{chargeId}/paid", {
params: { path: { chargeId: "55994eef-0000-4000-8000-d0c500000055" } },
body: {
recovered_pence: 1500
},
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.adminPostChargePaid(
path: .init(chargeId: "55994eef-0000-4000-8000-d0c500000055"),
body: .json(.init(
recoveredPence: 1500
))
).ok.body.json
print(response){
"switched_on": true,
"charges": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"our_reference": "<our_reference>",
"reason": "size_or_weight",
"amount_pence": 1500,
"recovered_pence": 1500,
"owed_pence": 1500,
"status": "owed",
"carrier_ref": "<carrier_ref>",
"note": "Added at the front desk",
"raised_at": "<raised_at>",
"settled_at": "<settled_at>",
"waived_reason": "Added at the front desk"
}
],
"owed_pence": 1500
}Internal-admin. Only an open charge. What she already paid stays recorded. Audited.
Why (kept on the charge and in the audit log).
POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.
Open charges, oldest first, then the most recently settled (at most 50).
The label this charge is for, by the reference Membber sent Royal Mail.
size_or_weightbanned_goodscancel_not_creditedotherWhat is still open: amount less recovered while owed, 0 once settled.
owedrecoveredwaivedThe line on Royal Mail's bill.
Everything open, across shops.
curl -X POST "https://www.membber.com/api/v1/admin-post/charges/55994eef-0000-4000-8000-d0c500000055/waive" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/charges/{chargeId}/waive", {
params: { path: { chargeId: "55994eef-0000-4000-8000-d0c500000055" } },
body: {
reason: "Added at the front desk"
},
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.adminPostChargeWaive(
path: .init(chargeId: "55994eef-0000-4000-8000-d0c500000055"),
body: .json(.init(
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"switched_on": true,
"charges": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"our_reference": "<our_reference>",
"reason": "size_or_weight",
"amount_pence": 1500,
"recovered_pence": 1500,
"owed_pence": 1500,
"status": "owed",
"carrier_ref": "<carrier_ref>",
"note": "Added at the front desk",
"raised_at": "<raised_at>",
"settled_at": "<settled_at>",
"waived_reason": "Added at the front desk"
}
],
"owed_pence": 1500
}Internal-admin. Every cancelled live Royal Mail label Membber bought that has no credit recorded, and any whose credit is recorded but whose label money has not gone back to the shop.
Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.
The reference Membber sent Royal Mail for this label: what to look for on the bill.
Royal Mail's own order id.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelRoyal Mail's price for this label when she asked for it.
What Royal Mail charged, once a person has read it from the bill. Null: not recorded.
Her label money still with Membber on this order. 0 once it has gone back.
awaiting_credit: no credit recorded yet. money_not_back: the credit is recorded but handing her label money back failed; record it again to retry.
awaiting_creditmoney_not_backWhat the write just did. Null on a read.
The credit on the label now. 0: Royal Mail will not credit it.
handed_back: her label money went back now. already_back: it had gone back before. label_stands: a newer label on the order is paid from it. not_yet: handing it back failed; record the credit again to retry. kept: no credit, the label money stays with Membber. none_held: no credit, and no label money was held on the order.
handed_backalready_backlabel_standsnot_yetkeptnone_heldcurl -G "https://www.membber.com/api/v1/admin-post/label-credits" \
-H "Authorization: Bearer $MEMBBER_TOKEN"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-post/label-credits");
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.adminPostLabelCredits().ok.body.json
print(response){
"labels": [
{
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"our_reference": "<our_reference>",
"carrier_order_id": "106ba913-0000-4000-8000-d0c500000010",
"tracking_number": "<tracking_number>",
"service": "tracked_48",
"parcel_kind": "letterbox",
"label_pence": 1500,
"charged_pence": 1500,
"cancelled_at": "<cancelled_at>",
"credited_at": "<credited_at>",
"credited_pence": 1500,
"held_pence": 1500,
"state": "awaiting_credit"
}
],
"result": {
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"credited_pence": 1500,
"money": "handed_back",
"handed_back_pence": 1500
}
}Internal-admin. Writes the credit on the label once (a second call never changes it) and hands the shop her label money back: all of it when the credit covers what the label cost, otherwise only what Royal Mail credited. Safe to repeat: the money goes back once. Refused for a label Membber did not buy, one that is not cancelled, or a credit above the label cost. Audited.
Royal Mail's credit for this label, whole pence, from the bill. Never more than the label cost.
What Royal Mail charged for this label, from the bill. Kept only when none is recorded yet.
Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.
The reference Membber sent Royal Mail for this label: what to look for on the bill.
Royal Mail's own order id.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelRoyal Mail's price for this label when she asked for it.
What Royal Mail charged, once a person has read it from the bill. Null: not recorded.
Her label money still with Membber on this order. 0 once it has gone back.
awaiting_credit: no credit recorded yet. money_not_back: the credit is recorded but handing her label money back failed; record it again to retry.
awaiting_creditmoney_not_backWhat the write just did. Null on a read.
The credit on the label now. 0: Royal Mail will not credit it.
handed_back: her label money went back now. already_back: it had gone back before. label_stands: a newer label on the order is paid from it. not_yet: handing it back failed; record the credit again to retry. kept: no credit, the label money stays with Membber. none_held: no credit, and no label money was held on the order.
handed_backalready_backlabel_standsnot_yetkeptnone_heldcurl -X POST "https://www.membber.com/api/v1/admin-post/label-credits/fc3b9b2f-0000-4000-8000-d0c5000000fc/credited" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"credited_pence": 1500
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/label-credits/{labelId}/credited", {
params: { path: { labelId: "fc3b9b2f-0000-4000-8000-d0c5000000fc" } },
body: {
credited_pence: 1500
},
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.adminPostLabelCredited(
path: .init(labelId: "fc3b9b2f-0000-4000-8000-d0c5000000fc"),
body: .json(.init(
creditedPence: 1500
))
).ok.body.json
print(response){
"labels": [
{
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"our_reference": "<our_reference>",
"carrier_order_id": "106ba913-0000-4000-8000-d0c500000010",
"tracking_number": "<tracking_number>",
"service": "tracked_48",
"parcel_kind": "letterbox",
"label_pence": 1500,
"charged_pence": 1500,
"cancelled_at": "<cancelled_at>",
"credited_at": "<credited_at>",
"credited_pence": 1500,
"held_pence": 1500,
"state": "awaiting_credit"
}
],
"result": {
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"credited_pence": 1500,
"money": "handed_back",
"handed_back_pence": 1500
}
}Internal-admin. Records that no credit is coming. The label money held on the order stays with Membber (it paid for that label) and the order takes no further Membber label; nothing new is taken from the shop. Refused once a credit is recorded. Audited.
What Royal Mail said (kept in the audit log; never shown to the shop).
Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.
The reference Membber sent Royal Mail for this label: what to look for on the bill.
Royal Mail's own order id.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelRoyal Mail's price for this label when she asked for it.
What Royal Mail charged, once a person has read it from the bill. Null: not recorded.
Her label money still with Membber on this order. 0 once it has gone back.
awaiting_credit: no credit recorded yet. money_not_back: the credit is recorded but handing her label money back failed; record it again to retry.
awaiting_creditmoney_not_backWhat the write just did. Null on a read.
The credit on the label now. 0: Royal Mail will not credit it.
handed_back: her label money went back now. already_back: it had gone back before. label_stands: a newer label on the order is paid from it. not_yet: handing it back failed; record the credit again to retry. kept: no credit, the label money stays with Membber. none_held: no credit, and no label money was held on the order.
handed_backalready_backlabel_standsnot_yetkeptnone_heldcurl -X POST "https://www.membber.com/api/v1/admin-post/label-credits/fc3b9b2f-0000-4000-8000-d0c5000000fc/not-credited" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"note": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/label-credits/{labelId}/not-credited", {
params: { path: { labelId: "fc3b9b2f-0000-4000-8000-d0c5000000fc" } },
body: {
note: "Added at the front desk"
},
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.adminPostLabelNotCredited(
path: .init(labelId: "fc3b9b2f-0000-4000-8000-d0c5000000fc"),
body: .json(.init(
note: "Added at the front desk"
))
).ok.body.json
print(response){
"labels": [
{
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"shop_name": "<shop_name>",
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"our_reference": "<our_reference>",
"carrier_order_id": "106ba913-0000-4000-8000-d0c500000010",
"tracking_number": "<tracking_number>",
"service": "tracked_48",
"parcel_kind": "letterbox",
"label_pence": 1500,
"charged_pence": 1500,
"cancelled_at": "<cancelled_at>",
"credited_at": "<credited_at>",
"credited_pence": 1500,
"held_pence": 1500,
"state": "awaiting_credit"
}
],
"result": {
"label_id": "8b381e46-0000-4000-8000-d0c50000008b",
"credited_pence": 1500,
"money": "handed_back",
"handed_back_pence": 1500
}
}Internal-admin. Every Royal Mail price row with the day it starts, the day it was last checked, and a warning on a price in force that is unchecked or was checked more than six months ago.
royal_mailToday in the UK, the day every state and warning was worked out for.
Every row, by service and parcel, newest start first.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelThe day a person last checked this price on the carrier's own site. Null: never.
in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.
pastin_forceupcomingOnly on a price in force: never checked, or last checked more than six months ago.
uncheckedstaleHow many prices in force are unchecked or stale, plus any service and parcel with no price in force.
A service and parcel with no price in force: buyers are offered no postage for it.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelcurl -G "https://www.membber.com/api/v1/admin-post/prices" \
-H "Authorization: Bearer $MEMBBER_TOKEN"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-post/prices");
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.adminPostPrices().ok.body.json
print(response){
"carrier": "royal_mail",
"today": "<today>",
"prices": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"service": "tracked_48",
"parcel_kind": "letterbox",
"price_pence": 1500,
"starts_on": "<starts_on>",
"checked_on": "<checked_on>",
"source_note": "Added at the front desk",
"state": "past",
"warning": "unchecked"
}
],
"warnings": -9007199254740991,
"missing": [
{
"service": "tracked_48",
"parcel_kind": "letterbox"
}
]
}Internal-admin. Adds a new dated row, marked checked today; no earlier row is changed. Refused for a past start day, or a second row for the same service, parcel and day. Audited.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelWhole pence, 1 to 10000.
The first day this price applies: today (UK) or later. A past day is refused, it would reprice history.
Where the price was read, for the next person.
royal_mailToday in the UK, the day every state and warning was worked out for.
Every row, by service and parcel, newest start first.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelThe day a person last checked this price on the carrier's own site. Null: never.
in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.
pastin_forceupcomingOnly on a price in force: never checked, or last checked more than six months ago.
uncheckedstaleHow many prices in force are unchecked or stale, plus any service and parcel with no price in force.
A service and parcel with no price in force: buyers are offered no postage for it.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelcurl -X POST "https://www.membber.com/api/v1/admin-post/prices" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"service": "tracked_48",
"parcel_kind": "letterbox",
"price_pence": 1500,
"starts_on": "<starts_on>"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/prices", {
body: {
service: "tracked_48",
parcel_kind: "letterbox",
price_pence: 1500,
starts_on: "<starts_on>"
},
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.adminPostPriceAdd(
body: .json(.init(
service: .tracked48,
parcelKind: .letterbox,
pricePence: 1500,
startsOn: "<starts_on>"
))
).ok.body.json
print(response){
"carrier": "royal_mail",
"today": "<today>",
"prices": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"service": "tracked_48",
"parcel_kind": "letterbox",
"price_pence": 1500,
"starts_on": "<starts_on>",
"checked_on": "<checked_on>",
"source_note": "Added at the front desk",
"state": "past",
"warning": "unchecked"
}
],
"warnings": -9007199254740991,
"missing": [
{
"service": "tracked_48",
"parcel_kind": "letterbox"
}
]
}Internal-admin. Records that a person checked this price on the carrier's own site today (UK). The price and its start day never change. Refused for a price that has been replaced. Audited.
royal_mailToday in the UK, the day every state and warning was worked out for.
Every row, by service and parcel, newest start first.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelThe day a person last checked this price on the carrier's own site. Null: never.
in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.
pastin_forceupcomingOnly on a price in force: never checked, or last checked more than six months ago.
uncheckedstaleHow many prices in force are unchecked or stale, plus any service and parcel with no price in force.
A service and parcel with no price in force: buyers are offered no postage for it.
tracked_48tracked_24letterboxsmall_parcelmedium_parcelcurl -X POST "https://www.membber.com/api/v1/admin-post/prices/ed388c44-0000-4000-8000-d0c5000000ed/checked" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/admin-post/prices/{priceId}/checked", {
params: { path: { priceId: "ed388c44-0000-4000-8000-d0c5000000ed" } },
body: {},
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.adminPostPriceChecked(
path: .init(priceId: "ed388c44-0000-4000-8000-d0c5000000ed"),
body: .json(.init())
).ok.body.json
print(response){
"carrier": "royal_mail",
"today": "<today>",
"prices": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"service": "tracked_48",
"parcel_kind": "letterbox",
"price_pence": 1500,
"starts_on": "<starts_on>",
"checked_on": "<checked_on>",
"source_note": "Added at the front desk",
"state": "past",
"warning": "unchecked"
}
],
"warnings": -9007199254740991,
"missing": [
{
"service": "tracked_48",
"parcel_kind": "letterbox"
}
]
}Internal-admin. Asks Royal Mail (Click & Drop GET /services) which services the Membber account has, so the Tracked 24 and Tracked 48 service codes are set from fact. Read only: it sets nothing and buys nothing. With labels switched off or no key set, Royal Mail is not called.
ok: Royal Mail answered. labels_off: Post or labels are switched off, nothing was called. no_key: no Royal Mail key is set, nothing was called. auth: Royal Mail refused the key or the account. failed: no answer, or one that could not be read.
oklabels_offno_keyauthfailedFalse: longer than the 10 characters Royal Mail allows a service code, so it cannot be set.
A guess from the name alone, to be checked by a person against the account. Null: no guess.
tracked_48tracked_24The setting that holds this code. Set in Vercel, never here.
The code set now, or null.
Whether Royal Mail lists that code on the account. Null: no code set, or Royal Mail was not asked.
The setting that holds this code. Set in Vercel, never here.
The code set now, or null.
Whether Royal Mail lists that code on the account. Null: no code set, or Royal Mail was not asked.
curl -G "https://www.membber.com/api/v1/admin-post/royal-mail/services" \
-H "Authorization: Bearer $MEMBBER_TOKEN"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-post/royal-mail/services");
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.adminRoyalMailServices().ok.body.json
print(response){
"status": "ok",
"http_status": -9007199254740991,
"carriers": [
{
"shipping_account_name": "<shipping_account_name>",
"services": [
{
"name": "Example name",
"code": "EXAMPLE10",
"code_fits": true,
"looks_like": "tracked_48"
}
]
}
],
"set_now": {
"tracked_48": {
"env_name": "<env_name>",
"code": "EXAMPLE10",
"on_account": true
},
"tracked_24": {
"env_name": "<env_name>",
"code": "EXAMPLE10",
"on_account": true
}
}
}Internal-admin. Each shop that has opened Post, with Membber's pause and how often she marked Posted with no tracking number.
Every shop that has opened Post or been paused, most recently changed first (at most 200).
Orders she has marked Posted.
Of those, marked Posted with no tracking number (decision 6).
curl -G "https://www.membber.com/api/v1/admin-post/shops" \
-H "Authorization: Bearer $MEMBBER_TOKEN"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/admin-post/shops");
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.adminPostShops().ok.body.json
print(response){
"shops": [
{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"name": "Example name",
"is_test": true,
"enabled": true,
"paused_by_membber": true,
"paused_at": "<paused_at>",
"paused_reason": "Added at the front desk",
"posted": -9007199254740991,
"posted_without_tracking": -9007199254740991
}
]
}Internal-admin. Rule 56: her paid parcels still show and can still be marked posted. Audited, with the reason.
true pauses Post for this shop: buyers no longer see it, paid parcels are untouched. false releases it.
Why (kept in the audit log and on the shop; never shown to the shop).
Orders she has marked Posted.
Of those, marked Posted with no tracking number (decision 6).
curl -X PUT "https://www.membber.com/api/v1/admin-post/shops/8fb04ddc-0000-4000-8000-d0c50000008f" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"paused": true,
"reason": "Added at the front desk"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.PUT("/api/v1/admin-post/shops/{storeId}", {
params: { path: { storeId: "8fb04ddc-0000-4000-8000-d0c50000008f" } },
body: {
paused: true,
reason: "Added at the front desk"
},
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.adminPostShopSet(
path: .init(storeId: "8fb04ddc-0000-4000-8000-d0c50000008f"),
body: .json(.init(
paused: true,
reason: "Added at the front desk"
))
).ok.body.json
print(response){
"shop": {
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"name": "Example name",
"is_test": true,
"enabled": true,
"paused_by_membber": true,
"paused_at": "<paused_at>",
"paused_reason": "Added at the front desk",
"posted": -9007199254740991,
"posted_without_tracking": -9007199254740991
}
}