API referenceAdmin post

Admin post

13 operations. Every schema and example on this page is generated from the platform contract.

Delivery by post: Royal Mail corrections owed by shops.

Internal-admin. Every open Royal Mail correction raised against a shop, and the most recently settled.

Response, 200

switched_onbooleanrequired

POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.

chargesarray of objectrequired

Open charges, oldest first, then the most recently settled (at most 50).

16 child fields
idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstring, nullablerequired
label_idstring, nullablerequired
our_referencestring, nullablerequired

The label this charge is for, by the reference Membber sent Royal Mail.

reasonenumrequired
size_or_weightbanned_goodscancel_not_creditedother
amount_penceintegerrequired
recovered_penceintegerrequired
owed_penceintegerrequired

What is still open: amount less recovered while owed, 0 once settled.

statusenumrequired
owedrecoveredwaived
carrier_refstring, nullablerequired

The line on Royal Mail's bill.

notestring, nullablerequired
raised_atstringrequired
settled_atstring, nullablerequired
waived_reasonstring, nullablerequired
owed_penceintegerrequired

Everything open, across shops.

curl -G "https://www.membber.com/api/v1/admin-post/charges" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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
}

Delivery by post: raise a Royal Mail correction against the shop whose label it was.

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.

Request body

our_referencestringrequired

The label's reference as it is on Royal Mail's bill (FLOU-7K2M4D-1).

reasonenumrequired
size_or_weightbanned_goodscancel_not_creditedother
amount_penceintegerrequired

What Royal Mail charged Membber for this correction, whole pence, from the bill. Never more.

carrier_refstringrequired

The line on Royal Mail's bill (invoice and line). One charge per label, reason and line.

notestringoptional

Response, 200

switched_onbooleanrequired

POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.

chargesarray of objectrequired

Open charges, oldest first, then the most recently settled (at most 50).

16 child fields
idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstring, nullablerequired
label_idstring, nullablerequired
our_referencestring, nullablerequired

The label this charge is for, by the reference Membber sent Royal Mail.

reasonenumrequired
size_or_weightbanned_goodscancel_not_creditedother
amount_penceintegerrequired
recovered_penceintegerrequired
owed_penceintegerrequired

What is still open: amount less recovered while owed, 0 once settled.

statusenumrequired
owedrecoveredwaived
carrier_refstring, nullablerequired

The line on Royal Mail's bill.

notestring, nullablerequired
raised_atstringrequired
settled_atstring, nullablerequired
waived_reasonstring, nullablerequired
owed_penceintegerrequired

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>"
  }'
Response, 200
{
  "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
}

Delivery by post: record what a shop has paid towards one charge.

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.

Parameters

chargeIdstringpathrequired

Request body

recovered_penceintegerrequired

What she has paid Membber towards this charge IN ALL, whole pence. Never less than recorded, never more than the charge.

Response, 200

switched_onbooleanrequired

POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.

chargesarray of objectrequired

Open charges, oldest first, then the most recently settled (at most 50).

16 child fields
idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstring, nullablerequired
label_idstring, nullablerequired
our_referencestring, nullablerequired

The label this charge is for, by the reference Membber sent Royal Mail.

reasonenumrequired
size_or_weightbanned_goodscancel_not_creditedother
amount_penceintegerrequired
recovered_penceintegerrequired
owed_penceintegerrequired

What is still open: amount less recovered while owed, 0 once settled.

statusenumrequired
owedrecoveredwaived
carrier_refstring, nullablerequired

The line on Royal Mail's bill.

notestring, nullablerequired
raised_atstringrequired
settled_atstring, nullablerequired
waived_reasonstring, nullablerequired
owed_penceintegerrequired

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
  }'
Response, 200
{
  "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
}

Delivery by post: waive what is left of one charge.

Internal-admin. Only an open charge. What she already paid stays recorded. Audited.

Parameters

chargeIdstringpathrequired

Request body

reasonstringrequired

Why (kept on the charge and in the audit log).

Response, 200

switched_onbooleanrequired

POST_LABEL_CORRECTIONS_ENABLED: false means no charge can be raised.

chargesarray of objectrequired

Open charges, oldest first, then the most recently settled (at most 50).

16 child fields
idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstring, nullablerequired
label_idstring, nullablerequired
our_referencestring, nullablerequired

The label this charge is for, by the reference Membber sent Royal Mail.

reasonenumrequired
size_or_weightbanned_goodscancel_not_creditedother
amount_penceintegerrequired
recovered_penceintegerrequired
owed_penceintegerrequired

What is still open: amount less recovered while owed, 0 once settled.

statusenumrequired
owedrecoveredwaived
carrier_refstring, nullablerequired

The line on Royal Mail's bill.

notestring, nullablerequired
raised_atstringrequired
settled_atstring, nullablerequired
waived_reasonstring, nullablerequired
owed_penceintegerrequired

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"
  }'
Response, 200
{
  "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
}

Delivery by post: cancelled Royal Mail labels waiting for their credit.

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.

Response, 200

labelsarray of objectrequired

Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.

17 child fields
label_idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstringrequired
order_numberstring, nullablerequired
our_referencestringrequired

The reference Membber sent Royal Mail for this label: what to look for on the bill.

carrier_order_idstringrequired

Royal Mail's own order id.

tracking_numberstring, nullablerequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
label_penceintegerrequired

Royal Mail's price for this label when she asked for it.

charged_penceinteger, nullablerequired

What Royal Mail charged, once a person has read it from the bill. Null: not recorded.

cancelled_atstring, nullablerequired
credited_atstring, nullablerequired
credited_penceinteger, nullablerequired
held_penceintegerrequired

Her label money still with Membber on this order. 0 once it has gone back.

stateenumrequired

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_back
resultobjectrequired

What the write just did. Null on a read.

4 child fields
label_idstringrequired
credited_penceintegerrequired

The credit on the label now. 0: Royal Mail will not credit it.

moneyenumrequired

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_held
handed_back_penceintegerrequired
curl -G "https://www.membber.com/api/v1/admin-post/label-credits" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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
  }
}

Delivery by post: record Royal Mail's credit for a cancelled label and hand the label money back.

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.

Parameters

labelIdstringpathrequired

Request body

credited_penceintegerrequired

Royal Mail's credit for this label, whole pence, from the bill. Never more than the label cost.

charged_penceintegeroptional

What Royal Mail charged for this label, from the bill. Kept only when none is recorded yet.

Response, 200

labelsarray of objectrequired

Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.

17 child fields
label_idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstringrequired
order_numberstring, nullablerequired
our_referencestringrequired

The reference Membber sent Royal Mail for this label: what to look for on the bill.

carrier_order_idstringrequired

Royal Mail's own order id.

tracking_numberstring, nullablerequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
label_penceintegerrequired

Royal Mail's price for this label when she asked for it.

charged_penceinteger, nullablerequired

What Royal Mail charged, once a person has read it from the bill. Null: not recorded.

cancelled_atstring, nullablerequired
credited_atstring, nullablerequired
credited_penceinteger, nullablerequired
held_penceintegerrequired

Her label money still with Membber on this order. 0 once it has gone back.

stateenumrequired

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_back
resultobjectrequired

What the write just did. Null on a read.

4 child fields
label_idstringrequired
credited_penceintegerrequired

The credit on the label now. 0: Royal Mail will not credit it.

moneyenumrequired

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_held
handed_back_penceintegerrequired
curl -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
  }'
Response, 200
{
  "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
  }
}

Delivery by post: Royal Mail will not credit a cancelled label.

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.

Parameters

labelIdstringpathrequired

Request body

notestringrequired

What Royal Mail said (kept in the audit log; never shown to the shop).

Response, 200

labelsarray of objectrequired

Cancelled Royal Mail labels with no credit recorded, oldest first, then any whose label money has not gone back yet.

17 child fields
label_idstringrequired
store_idstringrequired
shop_namestring, nullablerequired
order_idstringrequired
order_numberstring, nullablerequired
our_referencestringrequired

The reference Membber sent Royal Mail for this label: what to look for on the bill.

carrier_order_idstringrequired

Royal Mail's own order id.

tracking_numberstring, nullablerequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
label_penceintegerrequired

Royal Mail's price for this label when she asked for it.

charged_penceinteger, nullablerequired

What Royal Mail charged, once a person has read it from the bill. Null: not recorded.

cancelled_atstring, nullablerequired
credited_atstring, nullablerequired
credited_penceinteger, nullablerequired
held_penceintegerrequired

Her label money still with Membber on this order. 0 once it has gone back.

stateenumrequired

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_back
resultobjectrequired

What the write just did. Null on a read.

4 child fields
label_idstringrequired
credited_penceintegerrequired

The credit on the label now. 0: Royal Mail will not credit it.

moneyenumrequired

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_held
handed_back_penceintegerrequired
curl -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"
  }'
Response, 200
{
  "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
  }
}

Delivery by post: the dated price rows and which need checking.

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.

Response, 200

carrierenumrequired
royal_mail
todaystringrequired

Today in the UK, the day every state and warning was worked out for.

pricesarray of objectrequired

Every row, by service and parcel, newest start first.

9 child fields
idstringrequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
price_penceintegerrequired
starts_onstringrequired
checked_onstring, nullablerequired

The day a person last checked this price on the carrier's own site. Null: never.

source_notestring, nullablerequired
stateenumrequired

in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.

pastin_forceupcoming
warningenumrequired

Only on a price in force: never checked, or last checked more than six months ago.

uncheckedstale
warningsintegerrequired

How many prices in force are unchecked or stale, plus any service and parcel with no price in force.

missingarray of objectrequired

A service and parcel with no price in force: buyers are offered no postage for it.

2 child fields
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
curl -G "https://www.membber.com/api/v1/admin-post/prices" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "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"
    }
  ]
}

Delivery by post: add a price from a date.

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.

Request body

serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
price_penceintegerrequired

Whole pence, 1 to 10000.

starts_onstringrequired

The first day this price applies: today (UK) or later. A past day is refused, it would reprice history.

source_notestringoptional

Where the price was read, for the next person.

Response, 200

carrierenumrequired
royal_mail
todaystringrequired

Today in the UK, the day every state and warning was worked out for.

pricesarray of objectrequired

Every row, by service and parcel, newest start first.

9 child fields
idstringrequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
price_penceintegerrequired
starts_onstringrequired
checked_onstring, nullablerequired

The day a person last checked this price on the carrier's own site. Null: never.

source_notestring, nullablerequired
stateenumrequired

in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.

pastin_forceupcoming
warningenumrequired

Only on a price in force: never checked, or last checked more than six months ago.

uncheckedstale
warningsintegerrequired

How many prices in force are unchecked or stale, plus any service and parcel with no price in force.

missingarray of objectrequired

A service and parcel with no price in force: buyers are offered no postage for it.

2 child fields
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
curl -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>"
  }'
Response, 200
{
  "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"
    }
  ]
}

Delivery by post: mark one price checked today.

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.

Parameters

priceIdstringpathrequired

Response, 200

carrierenumrequired
royal_mail
todaystringrequired

Today in the UK, the day every state and warning was worked out for.

pricesarray of objectrequired

Every row, by service and parcel, newest start first.

9 child fields
idstringrequired
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
price_penceintegerrequired
starts_onstringrequired
checked_onstring, nullablerequired

The day a person last checked this price on the carrier's own site. Null: never.

source_notestring, nullablerequired
stateenumrequired

in_force: the price buyers pay today. upcoming: starts on a later day. past: replaced.

pastin_forceupcoming
warningenumrequired

Only on a price in force: never checked, or last checked more than six months ago.

uncheckedstale
warningsintegerrequired

How many prices in force are unchecked or stale, plus any service and parcel with no price in force.

missingarray of objectrequired

A service and parcel with no price in force: buyers are offered no postage for it.

2 child fields
serviceenumrequired
tracked_48tracked_24
parcel_kindenumrequired
letterboxsmall_parcelmedium_parcel
curl -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 '{}'
Response, 200
{
  "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"
    }
  ]
}

Delivery by post: the Royal Mail account's own services and their codes.

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.

auth internal-adminop adminRoyalMailServicesrate limitederrors

Response, 200

statusenumrequired

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_keyauthfailed
http_statusinteger, nullablerequired
carriersarray of objectrequired
2 child fields
shipping_account_namestringrequired
servicesarray of objectrequired
4 child fields
namestringrequired
codestringrequired
code_fitsbooleanrequired

False: longer than the 10 characters Royal Mail allows a service code, so it cannot be set.

looks_likeenumrequired

A guess from the name alone, to be checked by a person against the account. Null: no guess.

tracked_48tracked_24
set_nowobjectrequired
2 child fields
tracked_48objectrequired
3 child fields
env_namestringrequired

The setting that holds this code. Set in Vercel, never here.

codestring, nullablerequired

The code set now, or null.

on_accountboolean, nullablerequired

Whether Royal Mail lists that code on the account. Null: no code set, or Royal Mail was not asked.

tracked_24objectrequired
3 child fields
env_namestringrequired

The setting that holds this code. Set in Vercel, never here.

codestring, nullablerequired

The code set now, or null.

on_accountboolean, nullablerequired

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"
Response, 200
{
  "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
    }
  }
}

Delivery by post: shops, their pause and their posted-without-tracking count.

Internal-admin. Each shop that has opened Post, with Membber's pause and how often she marked Posted with no tracking number.

Response, 200

shopsarray of objectrequired

Every shop that has opened Post or been paused, most recently changed first (at most 200).

9 child fields
store_idstringrequired
namestring, nullablerequired
is_testbooleanrequired
enabledbooleanrequired
paused_by_membberbooleanrequired
paused_atstring, nullablerequired
paused_reasonstring, nullablerequired
postedintegerrequired

Orders she has marked Posted.

posted_without_trackingintegerrequired

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"
Response, 200
{
  "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
    }
  ]
}

Delivery by post: pause or release Post for one shop.

Internal-admin. Rule 56: her paid parcels still show and can still be marked posted. Audited, with the reason.

Parameters

storeIdstringpathrequired

Request body

pausedbooleanrequired

true pauses Post for this shop: buyers no longer see it, paid parcels are untouched. false releases it.

reasonstringrequired

Why (kept in the audit log and on the shop; never shown to the shop).

Response, 200

shopobjectrequired
9 child fields
store_idstringrequired
namestring, nullablerequired
is_testbooleanrequired
enabledbooleanrequired
paused_by_membberbooleanrequired
paused_atstring, nullablerequired
paused_reasonstring, nullablerequired
postedintegerrequired

Orders she has marked Posted.

posted_without_trackingintegerrequired

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"
  }'
Response, 200
{
  "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
  }
}
WhatsApp
Book a Call
Get Started
Admin post API | Membber Developers