commerce
commerce

Mint Offer

Write down a price agreed in conversation. Returns the code to send the buyer.

post/api/v1/commerce/offers

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/commerce/offers
  • Auth: API key in header X-API-Key

Request body

codestring nullable

Leave blank to mint one like GL-7K3Q9M

unit_centsinteger required

The agreed price per record, in cents — a ceiling on every grade

cap_recordsinteger nullable
cap_centsinteger nullable
bound_emailstring nullable

Only this buyer may use the code

expires_atstring date-time nullable
expires_in_daysinteger nullable
notestring nullable

Who and why — 'case study, Acme Web Design'

Response

Successful Response

codestring required
unit_centsinteger required
statusstring required
rulestring required
cap_recordsinteger nullable required
cap_centsinteger nullable required
remaining_recordsinteger nullable required
remaining_centsinteger nullable required
redeemed_recordsinteger required
redeemed_centsinteger required
bound_emailstring nullable required
expires_atstring date-time nullable required
revoked_atstring date-time nullable required
notestring nullable required
created_atstring date-time nullable required
ordersinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.