Add Coupon

Adds a coupon to the corresponding cart.

The Cart ID from the Create cart endpoint is used in the path parameter.

The Coupon ID, which is the coupon code generated when creating a custom coupon in Copilot, is used in the path parameter.

Authorizations

Authorization

string

header

required

This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"617329dfd5288b0011332311"

x-fabric-request-id

string

Unique request ID for tracking.

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

x-fabric-channel-id

string

x-fabric-channel-id identifies the sales channel through which the API request is being made; primarily for multichannel use cases. It is a required field. The default US channel is 12 while the default Canada channel is 11.

Example:

"12"

Path Parameters

cartId

string

required

The 24-character system-generated Cart ID. This ID is generated using the Create cart endpoint.

couponId

string

required

The Coupon ID is the coupon code generated when creating a custom coupon in Copilot.

Response

200

application/json

OK

Cart Response

id

string

The unique identifier of the cart, which is generated when the cart is created using the Create an empty cart endpoint.

Example:

"c86f777b-1885-4ddf-961d-542ba80a69b8"

attributes

object

Custom attributes used to describe the cart, such as a wishlist cart.

Show child attributes

attributes.{key}

object

Custom attributes used to describe the cart, such as a wishlist cart.

Example:

{ "name": "wishlist" }

Example:

{ "name": "wishlist" }

configuration

object

Cart configurations determine the behavior within the cart.

Show child attributes

configuration.order

object

Configuration settings related to order validation and processing.

Show child attributes

configuration.order.validate

object

Order validate determines the blocking behavior when creating an order draft.

Show child attributes

configuration.order.validate.paymentsRemaining

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is BLOCK.

Available options:

BLOCK,

NONE

configuration.order.validate.taxRemaining

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is BLOCK.

Available options:

BLOCK,

NONE

configuration.order.validate.invalidItem

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is BLOCK.

Available options:

BLOCK,

NONE

configuration.order.validate.itemOutOfStock

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is BLOCK.

Available options:

BLOCK,

NONE

configuration.product

object

Configuration settings related to product behavior and cache expiry.

Show child attributes

configuration.product.cacheExpiry

integer

Duration in seconds until product validation data expires.

Example:

7776000

configuration.product.behaviors

object

Behaviors related to inventory actions, such as adding the item or removing the item.

Show child attributes

configuration.product.behaviors.add

enum<string>

The behavior that is executed based on the selected configuration.

The default setting is REJECT.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"REJECT"

configuration.product.behaviors.update

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.product.behaviors.get

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.product.behaviors.cacheExpiry

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.product.maxQuantity

object

Item max quantity configurations

Show child attributes

configuration.product.maxQuantity.limit

integer

Maximum quantity for an individual line item

Example:

100

configuration.product.maxQuantity.behaviors

object

Max quantity behaviors

Show child attributes

configuration.product.maxQuantity.behaviors.add

enum<string>

The behavior that is executed based on the selected configuration.

The default setting is REJECT.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"REJECT"

configuration.product.maxQuantity.behaviors.update

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.product.maxQuantity.behaviors.get

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.inventory

object

Configuration settings related to inventory management and checks.

Show child attributes

configuration.inventory.cacheExpiry

integer

Duration in seconds until inventory validation data expires.

Example:

7776000

configuration.inventory.behaviors

object

Behaviors related to inventory actions, such as adding the item or removing the item.

Show child attributes

configuration.inventory.behaviors.add

enum<string>

The behavior that is executed based on the selected configuration.

The default setting is REJECT.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"REJECT"

configuration.inventory.behaviors.update

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.inventory.behaviors.get

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.inventory.behaviors.cacheExpiry

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.inventory.check

enum<string>

This setting is used to determine how you check inventory. The options are SKU or LINE_ITEM.

Available options:

SKU,

LINE_ITEM

Example:

"SKU"

configuration.tax

object

Configuration settings for tax calculations and behaviors.

Show child attributes

configuration.tax.cacheExpiry

integer

Duration in seconds until the tax data expires.

Example:

7776000

configuration.tax.behaviors

object

tax behaviors

Show child attributes

configuration.tax.behaviors.cacheExpiry

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

NONE

Example:

"WARN"

configuration.promotions

object

Configuration settings related to promotions and their cache expiry.

Show child attributes

configuration.promotions.cacheExpiry

integer

Duration in seconds until promotion data expires.

Example:

7776000

configuration.promotions.behaviors

object

Promotion behaviors

Show child attributes

configuration.promotions.behaviors.cacheExpiry

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

NONE

Example:

"WARN"

configuration.maxQuantity

object

Maximum quantity configurations to set when the cart reaches its limit.

Show child attributes

configuration.maxQuantity.limit

integer

The maximum quantity allowed across all items in the cart.

Example:

100

configuration.maxQuantity.behaviors

object

Max quantity behaviors

Show child attributes

configuration.maxQuantity.behaviors.add

enum<string>

The behavior that is executed based on the selected configuration.

The default setting is REJECT.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"REJECT"

configuration.maxQuantity.behaviors.update

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

configuration.maxQuantity.behaviors.get

enum<string>

The behavior that is executed based on the selected configuration.

The default behavior is WARN.

Available options:

WARN,

DROP,

REJECT,

NONE

Example:

"WARN"

customerContext

object

Customer context object containing customer information.

Show child attributes

customerContext.id

string

The Customer ID that was added to the customer attribute when using the Update customer endpoint.

Example:

"109840938"

customerContext.segments

object[]

An array containing segments of customer information.

Segment

Show child attributes

customerContext.segments.name

string

Segment name

Example:

"membership"

customerContext.segments.value

string[]

Segment values

Segment values

Example:

["gold", "silver"]

customerContext.attributes

object

Customer attributes such as email.

Show child attributes

customerContext.attributes.{key}

object

Customer attributes such as email.

Example:

{ "email": "[e-mail]" }

Example:

{ "email": "[e-mail]" }

customerContext.sessionId

string

Session ID of the customer.

Example:

"3a5fd2d3-5c96-4e57-b069-7ff2a88c1119"

status

enum<string>

The cart status indicates whether the cart is active or deleted.

Available options:

ACTIVE,

SOFT_DELETE

Example:

"ACTIVE"

state

object[]

The resource state is stored in an array that holds information about the current status of the cart.

Cart State

Show child attributes

state.resource

enum<string>

The type of resource indicating its current state, such as a cart.

Available options:

ITEM,

CART,

FULFILLMENT,

PAYMENT,

FEE,

VALIDATION

Example:

"CART"

state.resourceId

string

The ID used to reference the resource's state, such as a cart.

Example:

"c86f777b-1885-4ddf-961d-542ba80a69b8"

state.key

string

The key used to map the state of the resource.

Example:

"MISSING_PAYMENT_DETAILS"

state.description

string

A detailed description of the resource's current state, such as the absence of payment details.

Example:

"No payment details have been added to this Cart"

price

object

The sum of the total amount of the cart.

Show child attributes

price.total

number

The grand total, inclusive of all charges and discounts.

Example:

800

price.subtotal

number

The subtotal of all items amount.

Example:

750

price.tax

number

The tax total amount.

Example:

20

price.fulfillments

number

The fulfillments total amount.

Example:

25

price.discounts

number

The discounts total amount.

Example:

10

price.fees

number

The fees total amount.

Example:

5

price.adjustments

number

The adjustments total amount.

Example:

10

promotions

object

A collection of promotions applied to the corresponding cart.

Show child attributes

promotions.total

number

The total value of all applied promotions.

Example:

32

promotions.collection

object[]

An array containing promotions in the collection.

Promotions applied

Show child attributes

promotions.collection.id

string

The unique identifier of the promotion.

Example:

"542ba80a69b8"

promotions.collection.title

string

Promotion title

Example:

"15 Percent All Products"

promotions.collection.code

string

Coupon code

Example:

"15_PERCENT"

promotions.collection.type

string

The type of promotion, such as percentage or fixed value.

Example:

"PERCENTAGE"

promotions.collection.value

number

The value of the promotion, indicating the amount of the discount applied. This can be a fixed amount or a percentage.

Example:

15

promotions.collection.attributes

object

Custom attributes provide more context for the promotion.

Show child attributes

promotions.collection.attributes.{key}

object

Custom attributes provide more context for the promotion.

Example:

{ "source": "cart" }

Example:

{ "source": "cart" }

fees

object

A collection of fees associated with the corresponding cart.

Show child attributes

fees.total

number

The total fees amount in the collection.

Example:

5

fees.collection

object[]

An array containing all fees and their details in a collection.

Fee

Show child attributes

fees.collection.id

string

The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

fees.collection.name

string

Name of the fee

Example:

"Eco Fee"

fees.collection.price

object

Price details

Show child attributes

fees.collection.price.amount

number

required

Total fees amount

Required range: x > 0

Example:

12.99

fees.collection.taxable

boolean

A boolean value that determines whether a fee is taxable.

Example:

true

fees.collection.attributes

object

Custom attributes that provide more context for the fee, such as the source of the fee.

Show child attributes

fees.collection.attributes.{key}

object

Custom attributes that provide more context for the fee, such as the source of the fee.

Example:

{ "source": "eco" }

Example:

{ "source": "eco" }

fees.collection.tax

object

A collection of taxes.

Show child attributes

fees.collection.tax.total

number

Tax total in the collection.

Example:

3

fees.collection.tax.collection

object[]

An array containing taxes in a collection.

Tax

Show child attributes

fees.collection.tax.collection.amount

number

Tax amount

Example:

3

fees.collection.tax.collection.attributes

object

Custom attributes to provide more context to the tax, such as the rate and the type of tax.

Show child attributes

Example:

{ "rate": "5.0", "type": "COUNTY" }

fees.collection.updatedAt

string

The date and time when the fee was last updated.

Example:

"2024-06-13T16:50:00.682Z"

fees.collection.createdAt

string

The date and time when the fee was created.

Example:

"2024-06-13T16:50:00.682Z"

fees.collection.taxDetails

object

Tax details used to determine tax for a cart fee.

Show child attributes

fees.collection.taxDetails.destinationAddress

string

The destination address where the item will be delivered.

Example:

"c86f777b-1885-4ddf-961d-542ba80a69b8"

fees.collection.taxDetails.originAddress

string

The origin address from which the item will be fulfilled.

Example:

"c86f777b-1885-4ddf-961d-542ba80a69b8"

adjustments

object

A collection of adjustments made to the corresponding cart.

Show child attributes

adjustments.total

number

Adjustments total in a collection.

Example:

2

adjustments.collection

object[]

An array containing adjustments in the collection.

Adjustment

Show child attributes

adjustments.collection.id

string

The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

adjustments.collection.price

object

Price details

Show child attributes

adjustments.collection.price.amount

number

required

Total fees amount

Required range: x > 0

Example:

12.99

adjustments.collection.reason

string

The reason for the adjustment.

Example:

"Price adjustment from customer representative."

adjustments.collection.attributes

object

Custom attributes used for price adjustments.

Show child attributes

adjustments.collection.attributes.{key}

object

Custom attributes used for price adjustments.

Example:

{ "source": "CSR" }

Example:

{ "source": "CSR" }

adjustments.collection.updatedAt

string

The date and time when the adjustment was last updated.

Example:

"2024-06-13T16:50:00.682Z"

adjustments.collection.createdAt

string

The date and time when the adjustment was created.

Example:

"2024-06-13T16:50:00.682Z"

addresses

object

A map of addresses added to the corresponding cart.

Show child attributes

addresses.a8577d7f0d4d4b228e857b4a2e90dc93

object

Address

Show child attributes

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.id

string

The Address ID generated when an address was created using the Create address endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.name

object

Name of the recipient of the order.

Show child attributes

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.name.first

string

First name

Example:

"John"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.name.middle

string

Middle name

Example:

"S"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.name.last

string

Last name

Example:

"Doe"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.email

string

Email

Example:

"[e-mail]"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.phone

object

Phone

Show child attributes

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.phone.number

string

Phone Number

Example:

"123-456-7890"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.phone.type

enum<string>

Phone Number Type

Available options:

MOBILE,

BUSINESS,

HOME

Example:

"MOBILE"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.addressLine1

string

Address line 1

Example:

"123 Park Road"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.addressLine2

string

Address line 2

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.addressLine3

string

Address line 3

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.addressLine4

string

Address line 4

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.city

string

City

Example:

"Santa Cruz"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.region

string

State, Province or Area

Example:

"California"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.country

string

Country

Example:

"USA"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.postalCode

string

Postal code or zip code

Example:

"12345"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.updatedAt

string

The date and time the address was last updated.

Example:

"2024-06-13T16:50:00.682Z"

addresses.a8577d7f0d4d4b228e857b4a2e90dc93.createdAt

string

The date and time the address was created.

Example:

"2024-06-13T16:50:00.682Z"

lineItems

object

A collection of items in the cart.

Show child attributes

lineItems.total

number

Item total in a collection.

Example:

100

lineItems.collection

object[]

An array containing items in the collection.

Item Response

Show child attributes

lineItems.collection.id

string

The unique identifier of the item that was linked from making Create item endpoint

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

lineItems.collection.sku

string

The Stock Keeping Unit (SKU) associated with the item, used for inventory tracking and management.

Example:

"SKU3"

lineItems.collection.refId

string

An alternative identifier associated with the item, used for additional tracking or referencing.

Example:

"41"

lineItems.collection.quantity

integer

Quantity of item

Example:

10

lineItems.collection.priceListId

string

The unique identifier for a price list, used to reference and manage pricing information.

Example:

"10001"

lineItems.collection.position

integer

Position of the item in the cart..

Example:

1

lineItems.collection.price

object

Item price

Show child attributes

lineItems.collection.price.unit

number

The unit price of the item.

Example:

10

lineItems.collection.price.amount

number

The total price of the item, inclusive of quantity.

Example:

100

lineItems.collection.fees

object

A collection of fees associated with the corresponding cart.

Show child attributes

lineItems.collection.fees.total

number

The total fees amount in the collection.

Example:

5

lineItems.collection.fees.collection

object[]

An array containing all fees and their details in a collection.

Fee

Show child attributes

lineItems.collection.fees.collection.id

string

The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

lineItems.collection.fees.collection.name

string

Name of the fee

Example:

"Eco Fee"

lineItems.collection.fees.collection.price

object

Price details

Show child attributes

lineItems.collection.fees.collection.taxable

boolean

A boolean value that determines whether a fee is taxable.

Example:

true

lineItems.collection.fees.collection.attributes

object

Custom attributes that provide more context for the fee, such as the source of the fee.

Show child attributes

Example:

{ "source": "eco" }

lineItems.collection.fees.collection.tax

object

A collection of taxes.

Show child attributes

lineItems.collection.fees.collection.updatedAt

string

The date and time when the fee was last updated.

Example:

"2024-06-13T16:50:00.682Z"

lineItems.collection.fees.collection.createdAt

string

The date and time when the fee was created.

Example:

"2024-06-13T16:50:00.682Z"

lineItems.collection.fees.collection.taxDetails

object

Tax details used to determine tax for a cart fee.

Show child attributes

lineItems.collection.promotions

object

Collection of item promotions.

Show child attributes

lineItems.collection.promotions.total

number

Discount total in the collection.

Example:

2

lineItems.collection.promotions.collection

object[]

An array containing promotions in the collection.

Item Promotion

Show child attributes

lineItems.collection.promotions.collection.id

string

The unique identifier of the promotion.

Example:

"bb44db95-6fbd-4eed-a1ed-4d99bc91250f"

lineItems.collection.promotions.collection.amount

number

The discount amount applied to the item, excluding quantity.

Example:

15

lineItems.collection.promotions.collection.quantity

integer

The quantity of the item for which the discount is applicable.

Example:

3

lineItems.collection.promotions.collection.proration

object

Prorations

Show child attributes

lineItems.collection.adjustments

object

A collection of adjustments made to the corresponding cart.

Show child attributes

lineItems.collection.adjustments.total

number

Adjustments total in a collection.

Example:

2

lineItems.collection.adjustments.collection

object[]

An array containing adjustments in the collection.

Adjustment

Show child attributes

lineItems.collection.adjustments.collection.id

string

The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

lineItems.collection.adjustments.collection.price

object

Price details

Show child attributes

lineItems.collection.adjustments.collection.reason

string

The reason for the adjustment.

Example:

"Price adjustment from customer representative."

lineItems.collection.adjustments.collection.attributes

object

Custom attributes used for price adjustments.

Show child attributes

Example:

{ "source": "CSR" }

lineItems.collection.adjustments.collection.updatedAt

string

The date and time when the adjustment was last updated.

Example:

"2024-06-13T16:50:00.682Z"

lineItems.collection.adjustments.collection.createdAt

string

The date and time when the adjustment was created.

Example:

"2024-06-13T16:50:00.682Z"

lineItems.collection.fulfillment

object

Item Fulfillment

Show child attributes

lineItems.collection.fulfillment.id

string

The identifier of the fulfillment linked to the item.

Example:

"6d65755f-b1d9-4c9d-bb5b-118d317f8db4"

lineItems.collection.fulfillment.price

object

Price details

Show child attributes

lineItems.collection.fulfillment.price.amount

number

required

Total fees amount

Required range: x > 0

Example:

12.99

lineItems.collection.fulfillment.inventory

object

Inventory

Show child attributes

lineItems.collection.fulfillment.inventory.type

string

The type used to determine which counter to compare the quantity against.

Example:

"backOrder"

lineItems.collection.fulfillment.inventory.channels

object

The inventory channels associated with the item.

Show child attributes

Example:

{ "networkCode": "ShipToHome" }

lineItems.collection.fulfillment.tax

object

A collection of taxes.

Show child attributes

lineItems.collection.fulfillment.tax.total

number

Tax total in the collection.

Example:

3

lineItems.collection.fulfillment.tax.collection

object[]

An array containing taxes in a collection.

Tax

Show child attributes

lineItems.collection.attributes

object

Custom attributes

Show child attributes

lineItems.collection.attributes.{key}

object

Custom attributes

Example:

{ "name": "item-custom" }

Example:

{ "name": "item-custom" }

lineItems.collection.tax

object

A collection of taxes.

Show child attributes

lineItems.collection.tax.total

number

Tax total in the collection.

Example:

3

lineItems.collection.tax.collection

object[]

An array containing taxes in a collection.

Tax

Show child attributes

lineItems.collection.tax.collection.amount

number

Tax amount

Example:

3

lineItems.collection.tax.collection.attributes

object

Custom attributes to provide more context to the tax, such as the rate and the type of tax.

Show child attributes

Example:

{ "rate": "5.0", "type": "COUNTY" }

lineItems.collection.taxCode

string

The code used to identify and apply tax rates for transactions.

Example:

"10001"

lineItems.collection.updatedAt

string

The date and time the Item was last updated

Example:

"2024-06-13T16:50:00.682Z"

lineItems.collection.createdAt

string

The date and time a Item was created

Example:

"2024-06-13T16:50:00.682Z"

summary

object

A summary of items in the cart.

Show child attributes

summary.totalItems

integer

The total number of items in the cart, inclusive of quantity.

Example:

1

summary.totalUniqueItems

integer

The total number of unique items in the cart.

Example:

1

fulfillments

object

A map of fulfillments added to the corresponding cart.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e

object

A fulfillment object containing important fulfillment information.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.id

string

The Fulfillment ID generated when a fulfillment was created using the Create fulfillment endpoint.

Example:

"d6229cdb-0c5b-4885-b1b2-13b94d02488e"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.type

enum<string>

Determines the type of fulfillment.

Available options:

SHIP_TO,

BOPIS,

ROPIS

Example:

"SHIP_TO"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.refId

string

An alternative identifier for fulfillments, used for additional tracking or referencing.

Example:

"398427903843"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.attributes

object

Custom attributes to provide more context to the fulfillment, such as where it was made.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.attributes.{key}

object

Custom attributes to provide more context to the fulfillment, such as where it was made.

Example:

{ "source": "store" }

Example:

{ "source": "store" }

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.originAddress

string

The identifier of the address where the item is being fulfilled.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.destinationAddress

string

The identifier of the address where the item is being shipped.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.locationId

string

Unique identifier of the store.

Example:

"CA"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson

object

Pickup person details

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.primary

object

Name of the pickup person.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.primary.name

object

required

Name of the recipient of the order.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.primary.email

string

Email of the pickup person.

Example:

"[e-mail]"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.primary.phone

object

Phone

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.secondary

object[]

An array containing secondary people for pickup.

Name of the pickup person.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.secondary.name

object

required

Name of the recipient of the order.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.secondary.email

string

Email of the pickup person.

Example:

"[e-mail]"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.pickupPerson.secondary.phone

object

Phone

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.price

object

Price details

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.price.amount

number

required

Total fees amount

Required range: x > 0

Example:

12.99

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.promotions

object

A collection of promotions applied to the fulfillment.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.promotions.total

number

The total discount applied within a collection.

Example:

15

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.promotions.collection

object[]

An array containing the promotions within a collection.

Fulfillment Promotion

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.promotions.collection.id

string

Identifier of a promotion

Example:

"bb44db95-6fbd-4eed-a1ed-4d99bc91250f"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.promotions.collection.amount

number

The discount amount applied to a fulfillment.

Example:

15

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees

object

A collection of fees associated with the corresponding cart.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.total

number

The total fees amount in the collection.

Example:

5

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection

object[]

An array containing all fees and their details in a collection.

Fee

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.id

string

The unique identifier of the fee associated with the corresponding cart that was generated when making Create fee endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.name

string

Name of the fee

Example:

"Eco Fee"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.price

object

Price details

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.taxable

boolean

A boolean value that determines whether a fee is taxable.

Example:

true

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.attributes

object

Custom attributes that provide more context for the fee, such as the source of the fee.

Show child attributes

Example:

{ "source": "eco" }

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.tax

object

A collection of taxes.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.updatedAt

string

The date and time when the fee was last updated.

Example:

"2024-06-13T16:50:00.682Z"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.createdAt

string

The date and time when the fee was created.

Example:

"2024-06-13T16:50:00.682Z"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.fees.collection.taxDetails

object

Tax details used to determine tax for a cart fee.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments

object

A collection of adjustments made to the corresponding cart.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.total

number

Adjustments total in a collection.

Example:

2

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection

object[]

An array containing adjustments in the collection.

Adjustment

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.id

string

The Adjustment ID generated when an adjustment was created using the Create adjustment endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.price

object

Price details

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.reason

string

The reason for the adjustment.

Example:

"Price adjustment from customer representative."

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.attributes

object

Custom attributes used for price adjustments.

Show child attributes

Example:

{ "source": "CSR" }

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.updatedAt

string

The date and time when the adjustment was last updated.

Example:

"2024-06-13T16:50:00.682Z"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.adjustments.collection.createdAt

string

The date and time when the adjustment was created.

Example:

"2024-06-13T16:50:00.682Z"

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.tax

object

A collection of taxes.

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.tax.total

number

Tax total in the collection.

Example:

3

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.tax.collection

object[]

An array containing taxes in a collection.

Tax

Show child attributes

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.tax.collection.amount

number

Tax amount

Example:

3

fulfillments.d6229cdb0c5b4885b1b213b94d02488e.tax.collection.attributes

object

Custom attributes to provide more context to the tax, such as the rate and the type of tax.

Show child attributes

Example:

{ "rate": "5.0", "type": "COUNTY" }

coupons

object[]

An array containing all coupons added to the corresponding cart.

Coupon

Show child attributes

coupons.code

string

Coupon code

Example:

"VALID_COUPON"

coupons.updatedAt

string

The date when the coupon was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

appliedCoupons

object[]

An array containing all coupons applied to the cart.

Coupon

Show child attributes

appliedCoupons.code

string

Coupon code

Example:

"VALID_COUPON"

appliedCoupons.updatedAt

string

The date when the coupon was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

notAppliedCoupons

object[]

An array containing any coupons that were ineligible and not applied to the cart.

Coupon

Show child attributes

notAppliedCoupons.code

string

Coupon code

Example:

"VALID_COUPON"

notAppliedCoupons.updatedAt

string

The date when the coupon was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

validations

object

Show child attributes

validations.promotions

object

An object that contains promotion validation data.

Show child attributes

validations.promotions.updatedAt

string

The latest date when promotions data was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

validations.promotions.appliedCoupons

string[]

An array containing coupons that have been added to the corresponding cart.

Coupons that have been added to the corresponding cart.

Example:

["TEST_COUPON"]

validations.promotions.refreshRequired

boolean

A boolean value that determines whether promotions require a refresh.

Example:

false

validations.lineItems

object[]

An object that contains item validation data.

Show child attributes

validations.lineItems.sku

string

The SKU of the item.

Example:

"SKU3"

validations.lineItems.inventory

object

Inventory validation details

Show child attributes

validations.lineItems.inventory.channels

object

The inventory channels associated with the item.

Show child attributes

validations.lineItems.inventory.channels.{key}

string

The inventory channels associated with the item.

Example:

"{\"networkCode\":\"ShipToHome\"}"

Example:

{ "networkCode": "ShipToHome" }

validations.lineItems.inventory.counters

object

The inventory counters available for the item.

Show child attributes

validations.lineItems.inventory.counters.{key}

integer

The inventory counters available for the item.

Example:

{ "backOrder": 15, "preOrder": 100 }

validations.lineItems.inventory.updatedAt

string

The latest date when inventory was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

validations.product

object

Product validation data

Show child attributes

validations.product.availableSkus

object[]

An array containing product validation data.

Product validation data to determine product existence

Show child attributes

validations.product.availableSkus.sku

string

The SKU that exists within a Product Information Management (PIM) service.

Example:

"SKU3"

validations.product.availableSkus.updatedAt

string

The latest date when product data was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

validations.product.availableSkus.maxQuantity

integer

The maximum quantity allowed for a SKU.

Example:

100

validations.tax

object

An object that contains tax validation data.

Show child attributes

validations.tax.updatedAt

string

Latest date the tax was added to the corresponding cart.

Example:

"2024-06-13T16:50:00.682Z"

payments

object

An object containing a collection of payments added to the corresponding cart.

Show child attributes

payments.authorized

number

The payments that have been authorized within the collection.

Example:

800

payments.collection

object[]

An array containing payments within the collection.

Cart Payment

Show child attributes

payments.collection.id

string

The Payment ID that was generated when a payment was created using the Create payment endpoint.

Example:

"6ef2067a-5d6b-4785-a090-96ea0078220d"

payments.collection.provider

string

The payment provider, such as Verifone, that offers functions like transaction processing, gateway management, and other financial services.

Example:

"verifone"

payments.collection.processor

string

The payment processor, such as Stripe, responsible for handling and processing payment transactions by facilitating communication between the merchant and the issuing bank.

Example:

"stripe"

payments.collection.method

string

Payment method, such as Apple Pay, used for processing transactions.

Example:

"apple pay"

payments.collection.methodType

string

Payment method type, such as a credit card.

Example:

"credit card"

payments.collection.state

enum<string>

Payment state indicates whether the payment has been successfully processed.

Available options:

PENDING,

AUTHORIZED,

CAPTURED,

FAILED

Example:

"PENDING"

payments.collection.authorization

object

Payment authorization

Show child attributes

payments.collection.authorization.amount

number

required

The amount for which the payment has been authorized.

Required range: x > 0

Example:

8

payments.collection.authorization.expiry

string

The date when the payment authorization expires.

Example:

"2024-06-13T16:50:00.682Z"

payments.collection.authorization.verifier

object

Payment verifier

Show child attributes

payments.collection.authorization.verifier.type

string

The type of verification used, such as a token.

Example:

"TOKEN"

payments.collection.authorization.verifier.key

string

The key used for payment verification.

Example:

"CH39082K439R0"

payments.collection.billToAddress

string

The Address ID that was generated when an address was created using the Create address endpoint.

Example:

"a8577d7f-0d4d-4b22-8e85-7b4a2e90dc93"

payments.collection.cardDetails

object

Information about the card used for payment, such as gift card details.

Show child attributes

payments.collection.cardDetails.{key}

object

Information about the card used for payment, such as gift card details.

payments.collection.attributes

object

Custom attributes associated with the transaction, such as the name of the gift card used.

Show child attributes

payments.collection.attributes.{key}

object

Custom attributes associated with the transaction, such as the name of the gift card used.

Example:

{ "gift-card-name": "custom name" }

Example:

{ "gift-card-name": "custom name" }

channelId

string

Channel ID

Example:

"12"

currency

string

The currency that the cart will use when an order is created.

Example:

"USD"

updatedAt

string

The date and time in UTC when the cart was last updated.

Example:

"2024-06-13T16:50:00.682Z"

createdAt

string

The date and time when the cart was created.

Example:

"2024-06-13T16:50:00.682Z"