List the days no delivery estimate counts

data

• fromstring (date)required

  Today, YYYY-MM-DD in UTC.

• throughstring (date)required

  The last day this answer covers: the day before the same date next year, or the table's last day when that is sooner.

• timezonestringrequired

  Every date here, and in every estimate, is a UTC day.

  Always UTC

• weeklystring[]required

  The days of every week no estimate counts.

• daysobject[]required

  Every other day from from through through that no estimate counts, in date order.

• days[].datestring (date)required

  YYYY-MM-DD, UTC.

• days[].kindstringrequired

  federal_holiday: a legal public holiday of 5 U.S.C. 6103, on the weekday it is observed. plant_closure: a day the plant is closed.

  One of federal_holiday plant_closure

• days[].reasonstringrequired

  Why the day is not counted, in its source's words, e.g. "Thanksgiving Day", or "Independence Day (observed)" for the weekday that stands in for a weekend holiday.

• days[].sourcestringrequired

  Where the day comes from: the statute's URL for a federal holiday.

• order_byobject[]required

  The last day to order, by each parcel method on offer, for each day of a short table: Christmas Eve, Christmas Day, New Year's Eve (each in the next year it falls on or after today) and the next federal holiday after today, in date order. For our own plant's goods; another day, or another facility's goods, is answered by deliver_by_check.latest_order_day on POST /orders/quote. Estimates.

• order_by[].deliver_bystring (date)required

  The day the order should arrive by, YYYY-MM-DD in UTC.

• order_by[].occasionstringrequired

  What the day is: "Christmas Eve", "Christmas Day", "New Year's Eve", or the next federal holiday's name as days lists it.

• order_by[].methodstringrequired

  The shipping tiers this platform prices. Per parcel, not per item: standard by the parcel's weight class (POST /v1/shipping/estimate reports it), and for items made at the partner facility (apparel, mugs) at the larger of that and the partner's own estimate for the parcel; priority and express at their price and never below standard for the same parcel. An unrecognised value is refused with 400 validation_error rather than priced as standard. standard is always offered; priority and express are offered when priced (each at or above the USPS cost of the service), and until then a request for either is refused 400 shipping_method_unavailable, with details.offered naming the methods that are, and nothing is charged. letter is untracked letter mail for stickers and small vinyl decals from our own plant, offered only where the platform prices it, for an order whose every item qualifies, within a unit and an order-value ceiling: otherwise a request for it is refused 400 letter_mail_unavailable with details.reason, and nothing is charged. On the API it is never chosen for you — no default, estimate or storefront mapping picks it — and it is placed through POST /v1/order only (bulk and bundle orders ship by parcel). A hosted store is the one exception, and only where its merchant turned on small orders by letter in the dashboard's store editor (off by default, launched stores included): a qualifying basket bought on its store page or a buy link ships as a letter, and the shopper is told before paying. A letter has no carrier tracking: its order events and tracking page state the expected window, and POST /v1/order/{id}/missing-letter reships it once if it does not arrive.

  One of standard priority express letter

• order_by[].latest_order_daystring (date) | nullrequired

  The last UTC day an order placed by method is estimated to arrive by deliver_by (its estimated window's latest day on or before it); any time that day counts, and it may be a weekend or a holiday. Null when no order placed today or later is, which is the answer once the day has passed.

• order_by[].is_estimatebooleanrequired

  Always true.

  Always true

• peakobject | anyrequired

  The carrier's peak postage window, or null once it has ended (a new one is published when the carrier announces it).

• peak.fromstring (date)required

  The first day of the window, YYYY-MM-DD in UTC, inclusive.

• peak.throughstring (date)required

  The last day of the window, YYYY-MM-DD in UTC, inclusive.

• peak.in_windowbooleanrequired

  Whether today (UTC) is inside the window.

• peak.centsintegerrequired

  The surcharge per parcel, in cents, bare: the most the window adds to one parcel's rate before that rate is folded into an all-in figure. The amount on an order is the quote's shipping.surcharges[].amount_cents, folded the way its shipping is; a priority or express price set above the parcel's rate can hold some or all of it.

• peak.methodsstring[]required

  The parcel methods whose carrier expense can include it. PrintedSimply absorbs this expense; it is not a customer surcharge. Never letter: a letter carries no peak postage.

• peak.carrier_zonesobjectrequired

  The USPS zones the carrier's surcharge applies in, both inclusive. Our own parcel rate is one figure for every zone, so inside the window it holds the surcharge whatever the zone.

• peak.carrier_zones.fromintegerrequired
• peak.carrier_zones.throughintegerrequired
• peak.carrier_max_weight_lbintegerrequired

  The heaviest parcel, in pounds, the carrier's surcharge names. A heavier parcel carries the same amount here.

• peak.sourcestringrequired

  The carrier's own announcement of the window.

• advisoriesobject[]required

  Every carrier advisory not withdrawn and not yet over, soonest first: in effect today (active) or starting later. Empty when the carriers have posted none. A quote or shipping estimate into a destination one touches answers deliver_by_check.status at_risk.

• advisories[].idstringrequired

  adv_….

• advisories[].carrierstringrequired

  The carrier that posted it, as it names itself, e.g. "USPS".

• advisories[].statesstring[]required

  USPS state codes it touches. With zip_prefixes both empty, it touches every US destination.

• advisories[].zip_prefixesstring[]required

  ZIP prefixes (one to five digits) it touches, beside states.

• advisories[].fromstring (date)required

  The first day it applies, YYYY-MM-DD in UTC, inclusive.

• advisories[].throughstring (date)required

  The last day it applies, YYYY-MM-DD in UTC, inclusive.

• advisories[].activebooleanrequired

  Whether today (UTC) is inside from–through.

• advisories[].extra_daysintegerrequired

  The carrier's estimate of the business days it adds, as posted. An estimate.

• advisories[].messagestringrequired

  One sentence about it.

• advisories[].sourcestringrequired

  The carrier's own notice, as a URL.

meta

• pageinteger
• totalinteger
• limitinteger

  The page size actually applied, which is not necessarily the one asked for — the operation's own ceiling wins.

• pagesinteger

  total over limit, rounded up.

• next_cursorstring | null

  On a cursor-paged operation: send this back as cursor for the next page. Null on the last page. Absent on operations that do not page by cursor.

• has_moreboolean

  On a list operation whose meta is ListMeta: whether another page follows this one.