A TerminalHardwareShipping represents a Shipping Method for Terminal hardware. A Shipping Method is a country-specific representation of a way to ship hardware, containing information such as the country, name, and expected delivery date.
Attributes
- idstring
Unique identifier for the object.
- countryenum
The country in which this Shipping Method is available.
Possible enum valuesAD
AE
AF
AG
AI
AL
AM
AO
AQ
AR
Show 239 more - estimated_
delivery_ windowobject The estimated delivery period containing the estimated minimum and maximum delivery dates. These dates are not guaranteed.
- nameenum
The name of the Terminal Hardware Shipping Method.
Possible enum valuesexpress
Express
priority
Priority
standard
Standard
More attributes
- objectstring
- providernullable enum
- statusenum
- unavailable_
afternullable integer
{ "id": "thsm_MfuTjLaPEgXMa4", "object": "terminal.hardware_shipping_method", "country": "US", "estimated_delivery_window": { "maximum_date": "2023-10-03", "minimum_date": "2023-10-03" }, "name": "standard", "status": "available", "unavailable_after": null}
Retrieves a TerminalHardwareShippingMethod
object.
Parameters
No parameters.
Returns
Returns a TerminalHardwareShippingMethod
object if a valid identifier was provided.
{ "id": "thsm_MfuTjLaPEgXMa4", "object": "terminal.hardware_shipping_method", "country": "US", "estimated_delivery_window": { "maximum_date": "2023-10-03", "minimum_date": "2023-10-03" }, "name": "standard", "status": "available", "unavailable_after": null}
List all TerminalHardwareShippingMethod
objects.
Parameters
- countrystringRequired
Only return Shipping Methods that have the given country. If provided, country must be a two-letter country code (ISO 3166-1 alpha-2).
- nameenum
Only return Shipping Methods that have the given name.
Possible enum valuesexpress
Express
priority
Priority
standard
Standard
- statusenum
Only return Shipping Methods that have the given status. Defaults to Available.
Possible enum valuesavailable
Available for new orders.
unavailable
Can no longer be used for order creation.
More parameters
- ending_
beforestring - limitinteger
- providerenum
- starting_
afterstring
Returns
A dictionary with a data
property that contains an array of terminal hardware shipping methods. Each entry in the array is a separate ShippingMethod object.
{ "object": "list", "url": "/v1/terminal/hardware_shipping_methods", "has_more": false, "data": [ { "id": "thsm_MfuTjLaPEgXMa4", "object": "terminal.hardware_shipping_method", "country": "US", "estimated_delivery_window": { "maximum_date": "2023-10-03", "minimum_date": "2023-10-03" }, "name": "standard", "status": "available", "unavailable_after": null } ]}
A Configurations object represents how features should be configured for terminal readers. For information about how to use it, see the Terminal configurations documentation.