POST
/
carts
/
{cartId}
/
fulfillments
/
{fulfillmentId}
/
actions
/
add-attributes

Authorizations

Authorization
string
headerrequired

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.

x-fabric-request-id
string

Unique request ID for tracking.

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.

Path Parameters

cartId
string
required

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

fulfillmentId
string
required

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

Body

application/json

Add Attributes Request

attributes
object
required

An object containing custom attributes of your choice for the resource.

Response

200 - application/json

A fulfillment object containing important fulfillment information.

id
string

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

type
enum<string>

Determines the type of fulfillment.

Available options:
SHIP_TO,
BOPIS,
ROPIS
refId
string

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

attributes
object

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

originAddress
string

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

destinationAddress
string

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

locationId
string

Unique identifier of the store.

pickupPerson
object

Pickup person details

price
object

Price details

promotions
object

A collection of promotions applied to the fulfillment.

fees
object

A collection of fees associated with the corresponding cart.

adjustments
object

A collection of adjustments made to the corresponding cart.

tax
object

A collection of taxes.

Was this page helpful?

Create fulfillmentDelete fulfillment attributes