cards

Get a card

Look up one card by card_id with its status, dispatch date, estimated arrival and history, refreshed from the provider. Free. If the provider failed or cancelled the card, this call refunds its full charge to the balance, once.

get/v1/cards/{card_id}

Request

  • Base URL: https://api.noerrands.com/c/cards
  • URL: https://api.noerrands.com/c/cards/v1/cards/{card_id}
  • Auth: HTTP bearer

Path parameters

card_idstring required

From send_card or list_cards.

Response

Success.

card_idstring required
status'scheduled' | 'submitted' | 'in_production' | 'mailed' | 'delivered' | 'returned' | 'cancelled' | 'failed' required

scheduled (held until dispatch_on) -> submitted -> in_production -> mailed -> delivered; or returned, cancelled, failed.

tier'handwritten' | 'printed' required

handwritten: a folded card written with a real pen, in a stamped envelope. printed: a 6x9 postcard-style card, message printed on the back where anyone handling it can read it.

design_idstring required
design_namestring required
occasion'birthday' | 'thank_you' | 'sympathy' | 'holiday' | 'congratulations' | 'anniversary' | 'get_well' | 'thinking_of_you' | 'other' required

birthday, thank_you, sympathy, holiday, congratulations, anniversary, get_well, thinking_of_you or other.

messagestring

Absent once the 30-day retention window after mailing has closed.

signoffstring
handwriting_stylestring
dispatch_onstring date required

The day the card goes (or went) to the provider.

credits_charged_centsinteger required

Net of any refund.

created_atstring date-time required
mailed_atstring date-time

Changes

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