The Terminal Hardware Shipping Method object Preview

Attributes

• id string Unique identifier for the object.
• country enum The country in which this Shipping Method is available. Possible enum values AD AE AF AG AI AL AM AO AQ AR Show 239 more
• estimated _ delivery _ window object The estimated delivery period containing the estimated minimum and maximum delivery dates. These dates are not guaranteed.
• name enum The name of the Terminal Hardware Shipping Method. Possible enum values express Express freight Freight priority Priority standard Standard

More attributes

• object string, value is "terminal.hardware_shipping_method"
• provider nullable enum
• status enum
• unavailable _ after nullable integer

The Terminal Hardware Shipping Method object

{ "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}

Retrieve a Terminal Hardware Shipping Method Preview

GET / v1 / terminal / hardware_shipping_methods /:id

Retrieves a TerminalHardwareShippingMethod object.

Parameters

No parameters.

Returns

Returns a TerminalHardwareShippingMethod object if a valid identifier was provided.

cURL

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 Terminal Hardware Shipping Methods Preview

GET / v1 / terminal / hardware_shipping_methods

List all TerminalHardwareShippingMethod objects.

Parameters

• country string Required Only return Shipping Methods that have the given country. Country must be a two-letter country code ( ISO 3166-1 alpha-2).
• name enum Only return Shipping Methods that have the given name. Possible enum values express Express freight Freight priority Priority standard Standard
• status enum Only return Shipping Methods that have the given status. Defaults to Available. Possible enum values available Available for new orders. unavailable Can no longer be used for order creation.

More parameters

• ending _ before string
• limit integer
• provider enum
• starting _ after string

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.

cURL

Response