Skip to main content

A type used to specify a period of time using a specified time-measurement unit. Payment, return, and fulfillment business policies all use this type to specify time windows.

Whenever a container that uses this type is used in a request, both of these fields are required. Similarly, whenever a container that uses this type is returned in a response, both of these fields are always returned.

Types that use TimeDuration

DepositFulfillmentPolicyFulfillmentPolicyRequestInternationalReturnOverrideTypePaymentPolicyPaymentPolicyRequestReturnPolicyReturnPolicyRequestSetFulfillmentPolicyResponseSetPaymentPolicyResponseSetReturnPolicyResponseSubscription

Calls that use TimeDuration

POST
/fulfillment_policy/
PUT
/fulfillment_policy/{fulfillmentPolicyId}
GET
/fulfillment_policy
GET
/fulfillment_policy/{fulfillmentPolicyId}
GET
/fulfillment_policy/get_by_policy_name
POST
/payment_policy
PUT
/payment_policy/{payment_policy_id}
GET
/payment_policy
GET
/payment_policy/{payment_policy_id}
GET
/payment_policy/get_by_policy_name
POST
/return_policy
PUT
/return_policy/{return_policy_id}
GET
/return_policy
GET
/return_policy/{return_policy_id}
GET
/return_policy/get_by_policy_name
GET
/subscription

Fields

Field
Type
Description
unit
TimeDurationUnitEnum
These enum values represent the time measurement unit, such as DAY. A span of time is defined when you apply the value specified in the value field to the value specified for unit.

See TimeDurationUnitEnum for a complete list of possible time-measurement units.
value
integer
An integer that represents an amount of time, as measured by the time-measurement unit specified in the unit field.