Retrieves a TerminalHardwareShippingMethod object.
Parameters
No parameters.
Returns
Returns a TerminalHardwareShippingMethod object if a valid identifier was provided.
Response
{ "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 valuesexpressExpress
priorityPriority
standardStandard
- statusenum
Only return Shipping Methods that have the given status. Defaults to Available.
Possible enum valuesavailableAvailable for new orders.
unavailableCan 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.
Response
{ "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 } ]}- Need help? Contact Support.
- Check out our changelog.
- Questions? Contact Sales.
- LLM? Read llms.txt.
- Powered by Markdoc