We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.

Subscriptions (SMT API) (2.0.0)

Download OpenAPI specification:Download

E-mail: support@fabric.inc License: fabric API License

fabric's Subscriptions API lets your customers set recurring purchases of their desired products or services for a scheduled period (weekly, monthly, etc.). In addition, Subscriptions helps you retrieve and update subscription details, and lets your customers skip one or more subscription schedules, or remove a subscription. This API also lets you create and updates customers cancellation reasons, and subscription discounts.

Subscribers

These endpoints let you create, update, or get one or all of your subscribers (customers who have subscriptions). If you request all subscribers, you will receive a paginated response; you can specify the page size, and which page you want.

Create subscriber

Create new subscriber with specified details

Request

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Details of customer being created

customerReferenceId required	string Unique customer reference ID
locale required	string Customer locale (language_country)
email required	string Customer's email address
contactnumber	string Customer's contact number
firstName required	string Customer's first name
middleName	string Customer's middle name or initial
lastName required	string Customer's last name
segment	Array of strings Customer's segments
employeeId	string Customer employee ID
required	object (communicationPreference) Customer's communications preferences

Responses

200

Request processed successfully

400

Bad request

post/v1/customers

Request samples

Payload

application/json

{"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
}
}

Response samples

application/json

{"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}

Get single subscriber's account

Get details of single customer, specified by customer ID

Request

path Parameters

required

string

Customer ID

Example: 62cffd65e8d7eb868c6a29d6

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

404

Not found

get/v1/customers/{id}

Response samples

application/json

{"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}

Update single subscriber

Update single subscriber, specified by customer ID

Request

path Parameters

required

string

Customer ID

Example: 62cffd65e8d7eb868c6a29d6

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Details of customer being updated

customerReferenceId required	string Unique customer reference ID
locale required	string Customer locale (language_country)
email required	string Customer's email address
contactnumber	string Customer's contact number
firstName required	string Customer's first name
middleName	string Customer's middle name or initial
lastName required	string Customer's last name
segment	Array of strings Customer's segments
employeeId	string Customer employee ID
required	object (communicationPreference) Customer's communications preferences

Responses

200

Request processed successfully

400

Bad request

404

Not found

put/v1/customers/{id}

Request samples

Payload

application/json

{"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
}
}

Response samples

application/json

{"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}

Update single subscriber's shipping and billing information

Update single subscriber's shipping and billing information (subscriber specified by customer ID)

Request

path Parameters

required

string

Customer ID

Example: 62cffd65e8d7eb868c6a29d6

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Details for updating customer billing and shipping information

	object (AddressShipTo) Ship-to address and phone details
	object (Address) Bill-to address and phone details

Responses

200

Request processed successfully

400

Bad request

404

Not found

patch/v1/customers/{id}/subscriptions

Request samples

Payload

application/json

{"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
}
}

Response samples

application/json

{"subscriptions": [{"item": {"sku": "MOBO-X570"
}
}
]
}

Subscriptions

These endpoints let your customers set recurring purchases of their desired products or services for a scheduled period (weekly, monthly, etc.). In addition, these endpoints let you get and update subscription details, and let your customers skip one or more subscription schedules, or remove a subscription.

Get all subscriptions

Get all subscriptions (response is paginated)

Request

query Parameters

limit	number Maximum number of subscriptions to return per page Example: limit=10
offset	number Page number Example: offset=0
status	string Subscription status Example: status=ACTIVE

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

404

Subscription not found

get/v1/subscriptions

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"subscriptions": [{"id": "6256610bc312410009b7390b",
"customer": {"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
},
"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"status": "ACTIVE",
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"channel": "WEBSITE",
"originOrderId": "22-4498-4800",
"offsetDays": 2,
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z"
}
],
"query": {"limit": 10,
"offset": 10,
"count": 100
}
}
}

Get single subscription

Get single subscription by subscription ID

Request

path Parameters

required

string

Subscription ID

Example: 6169b2d892a5f30009d76480

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

404

Subscription not found

get/v1/subscriptions/{id}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"subscription": {"id": "6256610bc312410009b7390b",
"customer": {"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
},
"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"status": "ACTIVE",
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"channel": "WEBSITE",
"originOrderId": "22-4498-4800",
"offsetDays": 2,
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z"
}
}
}

Update single subscription

Update single subscription by subscription ID

Request

path Parameters

required

string

Subscription ID

Example: 6169b2d892a5f30009d76480

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

channel	string Channel Enum: "WEBSITE" "POS"
	object (CustomerUpdateBody) Customer details to be updated
	object (AddressUpdateShipTo) Ship to details
	object (AddressUpdate) Billing address update details
	object (UpdatePaymentDetails) Payment details to be updated
	object (CustomAttributes) Custom attributes
	object (UpdateItem) Item details to be updated
	object (UpdatePlan) Subscription plan details
	object (UpdateOffer) Offer details to be updated
	object (UpdateShipping) Shipping details to be updated
	object (Expiry) Expiration date and billing cycle

Responses

200

Request processed successfully

404

Subscription not found

patch/v1/subscriptions/{id}

Request samples

Payload

application/json

{"channel": "WEBSITE",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
}
},
"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "credit"
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
}
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"subscription": {"id": "6256610bc312410009b7390b",
"customer": {"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
},
"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"status": "ACTIVE",
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"channel": "WEBSITE",
"originOrderId": "22-4498-4800",
"offsetDays": 2,
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z"
}
}
}

Create bulk subscriptions

Request

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

channel required	string Channel Enum: "WEBSITE" "POS"
originOrderId	string Client's origin order ID
	object (CustomerBody) Customer details
required	object (AddressShipTo) Ship-to address and phone details
required	object (Address) Bill-to address and phone details
required	object (PaymentDetails) Payment details
	object (CustomAttributes) Custom attributes
	Array of objects (SubscriptionItems) Subscription items

Responses

200

Request processed successfully

400

Bad request

post/v1/subscriptions/bulk

Request samples

Payload

application/json

{"channel": "WEBSITE",
"originOrderId": "22-4498-4800",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
}
},
"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"item": [{"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offsetDays": 2,
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
}
}
]
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"subscriptions": [{"id": "6256610bc312410009b7390b",
"item": {"sku": "MOBO-X570"
},
"customer": {"id": "62cffd65e8d7eb868c6a29d6",
"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactNumber": "+923333709568",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segment": ["employee"
],
"employeeId": "345",
"communicationPreference": {"email": true,
"sms": true
},
"status": "ACTIVE",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}
}
],
"errors": [{"lineItemId": 1,
"code": "SUBSCRIPTION_NOT_FOUND"
}
]
}
}

Deactivate single subscription

Deactivate single subscription by subscription ID

Request

path Parameters

required

string

Subscription ID

Example: 6169b2d892a5f30009d76480

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

put/v1/subscriptions/{id}/inactive

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "6256610bc312410009b7390b",
"status": "INACTIVE"
}
}

Reactivate single subscription

Reactivate single subscription by subscription ID

Request

path Parameters

required

string

Subscription ID

Example: 6169b2d892a5f30009d76480

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

put/v1/subscriptions/{id}/reactivate

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "6256610bc312410009b7390b",
"status": "ACTIVE"
}
}

Replace a subscription item

Replace a subscription item (with details) by specifying item SKU

Request

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

	object Replacement item details
	object Replacement item details

Responses

200

Request processed successfully

400

Bad request

post/v1/subscriptions/replace-items

Request samples

Payload

application/json

{"item": {"sku": "MOBO-X570"
},
"replacementItem": {"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"expiry": {"expiryDate": "2022-07-18T09:16:11.437Z",
"billingCycles": 2
}
}
}

Response samples

application/json

{"responseStatus": "OK",
"message": "This request to replace items is currently being processed. Once done, we will update you via your webhooks (your webhooks need to be configured). Refer to our documentation on more information on webhooks."
}

Discontinue items in subscription

Discontinue items in subscription by specifying item SKUs

Request

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

sku	Array of strings SKUs

Responses

200

Request processed successfully

post/v1/subscriptions/discontinued-items

Request samples

Payload

application/json

{"sku": ["MOBO-X570"
]
}

Response samples

application/json

{"responseStatus": "OK",
"message": "This request to replace items is currently being processed. Once done, we will update you via your webhooks (your webhooks need to be configured). Refer to our documentation on more information on webhooks."
}

Orders

These endpoints let your customers purchase products and services from your store.

Get single order

Get single order, specified by order ID

Request

path Parameters

orderId

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

403

Unauthorized

404

Not found

get/v1/orders/{orderId}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
}
}

Update single order

Update single order, specified by order ID

Request

path Parameters

orderId

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

object (UpdateOrder)

Order details to be updated

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

patch/v1/orders/{orderId}

Request samples

Payload

application/json

{"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"scheduledDate": "2019-01-01T00:00:00.000Z",
"status": "SCHEDULED",
"lineItems": [{"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"Item": {"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
]
}
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
}
}

Get all orders for a specific customer

Get all orders for a specified customer, specified by customer ID

Request

path Parameters

customerId

required

string (Id)

Customer reference ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

403

Unauthorized

404

Not found

get/v1/customers/{customerId}/orders

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"orders": [{"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": null,
"frequency": null,
"frequencyType": null
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": null,
"currencyCode": null
},
"tax": {"taxCode": null,
"taxAmount": null,
"currencyCode": null
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
]
}
}

Trigger single order

Trigger order specified by order ID

Request

path Parameters

orderId

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

403

Unauthorized

404

Not found

get/v1/orders/{orderId}/trigger-now

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
}
}

Skip single order

Skip order specified by order ID

Request

path Parameters

orderId

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

put/v1/orders/{orderId}/skip

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"Order": {"id": "6384462ab645220008a4358a",
"status": "SKIPPED"
},
"dateSkipped": "2020-01-01T00:00:00.000Z",
"nextScheduledOrders": {"newOrders": ["62d51ab385a8cd00092eb8b7"
],
"subscriptions": ["62d51ab385a8cd00092eb8b7"
]
},
"errors": [{"lineItemId": 1,
"code": "SUBSCRIPTION_NOT_FOUND"
}
]
}
}

Remove items from single order

Remove items from order specified by order ID

Request

path Parameters

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

lineItemIds

Array of integers

Line items to remove from order

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

post/v1/orders/{id}/remove-items

Request samples

Payload

application/json

{"lineItemIds": [1
]
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
}
}

Add items to single order

Add items to order specified by order ID

Request

path Parameters

required

string (Id)

Order ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Array of objects (AddItemToOrderItems)

Line items to add to order

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

post/v1/orders/{id}/add-items

Request samples

Payload

application/json

{"lineItems": [{"subscriptionId": "6256610bc312410009b7390b",
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
}
}
]
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"order": {"shipTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"billTo": {"name": {"firstName": "Pat",
"middleName": "E",
"lastName": "Kake"
},
"streetAddress": {"street1": "123 Main St",
"street2": "Suite 100"
},
"city": "Boston",
"state": "MA",
"postalCode": "02127",
"country": "US",
"phone": {"number": "5555551234",
"kind": "home"
}
},
"paymentDetails": {"paymentIdentifier": {"cardIdentifier": "1234",
"expiryDate": "12/20"
},
"paymentMethod": "credit_card",
"paymentKind": "Visa"
},
"isDeleted": false,
"deletedAt": "2019-01-01T00:00:00.000Z",
"id": "6384462ab645220008a4358a",
"status": "SCHEDULED",
"totalAmount": 100,
"totalTax": 10,
"totalDiscount": 10,
"currencyCode": "USD",
"scheduledDate": "2019-01-01T00:00:00.000Z",
"customer": {"customerReferenceId": "12345",
"locale": "en_US",
"email": "customer@example.com",
"contactnumber": "5555551234",
"firstName": "Pat",
"middleName": "E",
"lastName": "Kake",
"segments": ["employee"
],
"employeeId": "345",
"status": "ACTIVE",
"isDeleted": false,
"DeletedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2019-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"communicationPreference": {"email": true,
"sms": true
}
},
"lineItems": [{"subscription": {"plan": {"id": "1001",
"frequency": 30,
"frequencyType": "Daily"
},
"id": "6256610bc312410009b7390b"
},
"item": {"id": 1000000006,
"sku": "MOBO-X570",
"quantity": 1,
"weight": 10,
"weightUnit": "lb",
"title": "Vitamin",
"description": "Vitamin C",
"itemPrice": {"price": 100,
"currencyCode": "USD"
},
"tax": {"taxCode": "FR020000",
"taxAmount": 10,
"currencyCode": "USD"
}
},
"shipping": {"shipmentCarrier": "USPS",
"shipmentMethod": "Ground",
"shipmentInstructions": "Please leave the package in the box",
"taxCode": "SHP020000",
"shippingAmount": 10,
"taxAmount": 1,
"currencyCode": "USD"
},
"offer": {"id": "SUB-E10717",
"source": "PDP"
},
"lineItemId": 1,
"customAttributes": {"storeId": "60cb07fc20387b000821c5c3",
"associateId": 1,
"trackingUrl": "609436d21baded0008945b05"
}
}
],
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"statusUpdatedAt": "2021-10-14T10:24:36.468Z",
"Retry": {"maxRetries": 3,
"retryType": "PAYMENT RETRY",
"retryAfterDays": 1,
"retryCount": 2
},
"error": {"errorCode": "ORDER_NOT_FOUND",
"errorMessage": "The order is not found"
}
}
}
}

Cancellation Reasons

These endpoints let you create and get cancellation reasons.

Get all cancellation reasons

Request

header Parameters

Authorization

required

string

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

403

Unauthorized access

get/v1/cancellation-reasons

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": [{"_id": "string",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z",
"code": 99,
"reason": "Customer is not happy"
}
]
}

Create cancellation reasons

Request

header Parameters

Authorization

required

string

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Cancellation reason to be created

Array

code	number Cancellation code
reason	string Cancellation reason

Responses

200

Request processed successfully

400

Bad Request

403

Unauthorized access

post/v1/cancellation-reasons

Request samples

Payload

application/json

[{"code": 99,
"reason": "Customer is not happy"
}
]

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": [{"code": 99,
"reason": "Customer is not happy"
}
]
}

Subscription Discounts

These endpoints let you create, update, deactivate, and get discount offers for the orders placed by your customers.

Create subscription discounts

Request

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Details of subscription discount to be created

	object (Validity) Dates during which discount is valid, and orders to which discount applies
message	string Merchant discount message
	object (Discount) Discount detail
skus	Array of strings SKUs to which discount applies
categories	Array of strings Product categories
	object (Frequency) Shipping frequency details
itemQuantity	integer Number of items
channel	string Channel Enum: "WEBSITE" "POS"
target	string Discount target Enum: "PDP" "CART" "QUICK VIEW" "SUBSCRIPTION MANAGEMENT PORTAL"
customerSegment	Array of strings Customer segments

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

post/v1/subscriptionDiscount

Request samples

Payload

application/json

{"validity": {"startDate": "2022-07-21T13:14:51.474Z",
"endDate": "2022-07-21T13:14:51.474Z",
"applyOnOrders": [2,
3
]
},
"message": "Offer terms and conditions",
"discount": {"amount": 10
},
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP",
"customerSegment": ["employee"
]
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "62d9196aeec12800095633f2",
"status": "ACTIVE",
"offerCode": "SUB-D45DD7",
"validity": {"startDate": "2022-07-21T13:14:51.474Z",
"endDate": "2022-07-21T13:14:51.474Z",
"applyOnOrders": [2,
3
]
},
"message": "Offer terms and conditions",
"discount": {"amount": 10
},
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP",
"customerSegment": ["employee"
],
"isDeleted": false,
"DeletedAt": "2019-01-01T00:00:00.000Z",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}
}

Get a subscription discount

Get a subscription discount for a specified offer (specified by offer ID)

Request

path Parameters

offerId

required

string

Offer code

Example: SUB-D45DD7

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

403

Unauthorized

404

Not found

get/v1/subscriptionDiscount/{offerId}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "62d9196aeec12800095633f2",
"status": "ACTIVE",
"offerCode": "SUB-D45DD7",
"validity": {"startDate": "2022-07-21T13:14:51.474Z",
"endDate": "2022-07-21T13:14:51.474Z",
"applyOnOrders": [2,
3
]
},
"message": "Offer terms and conditions",
"discount": {"amount": 10
},
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP",
"customerSegment": ["employee"
],
"isDeleted": false,
"DeletedAt": "2019-01-01T00:00:00.000Z",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}
}

Update a subscription discount

Update a subscription discount for a specified offer (specified by offer ID)

Request

path Parameters

offerId

required

string (Id)

Offer ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Request Body schema: application/json

Details used to update discount

	object (Discount) Discount detail
message	string Merchant discount message
skus	Array of strings SKUs
categories	Array of strings Product categories
	object (Frequency) Shipping frequency details
itemQuantity	integer Number of items
channel	string Channel Enum: "WEBSITE" "POS"
target	string Discount target Enum: "PDP" "CART" "QUICK VIEW" "SUBSCRIPTION MANAGEMENT PORTAL"

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

put/v1/subscriptionDiscount/{offerId}

Request samples

Payload

application/json

{"discount": {"amount": 10
},
"message": "Offer terms and conditions",
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP"
}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "62d9196aeec12800095633f2",
"status": "ACTIVE",
"offerCode": "SUB-D45DD7",
"validity": {"startDate": "2022-07-21T13:14:51.474Z",
"endDate": "2022-07-21T13:14:51.474Z",
"applyOnOrders": [2,
3
]
},
"message": "Offer terms and conditions",
"discount": {"amount": 10
},
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP",
"customerSegment": ["employee"
],
"isDeleted": false,
"DeletedAt": "2019-01-01T00:00:00.000Z",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}
}

Deactivate a subscription discount

Deactivate a specified subscription discount (specified by discount ID)

Request

path Parameters

required

string (Id)

Discount ID

Example: 606f01f441b8fc0008529916

header Parameters

Authorization

required

string (Authorization)

JWT authorization token

Example: eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjYxZjIyMTU4...

Responses

200

Request processed successfully

400

Bad request

403

Unauthorized

404

Not found

patch/v1/subscriptionDiscount/deactivate/{id}

Response samples

application/json

{"responseStatus": "OK",
"message": "Request processed successfully",
"data": {"id": "62d9196aeec12800095633f2",
"status": "INACTIVE",
"offerCode": "SUB-D45DD7",
"validity": {"startDate": "2022-07-21T13:14:51.474Z",
"endDate": "2022-07-21T13:14:51.474Z",
"applyOnOrders": [2,
3
]
},
"message": "Offer terms and conditions",
"discount": {"amount": 10
},
"skus": ["MOBO-X570"
],
"categories": ["holiday-best-sellers"
],
"frequency": {"shippingFrequency": 1,
"shippingFrequencyType": "daily",
"billingFrequency": 1,
"billingFrequencyType": "daily"
},
"itemQuantity": 1,
"channel": "WEBSITE",
"target": "PDP",
"customerSegment": ["employee"
],
"isDeleted": false,
"DeletedAt": "2019-01-01T00:00:00.000Z",
"createdAt": "2021-10-12T21:35:05.756Z",
"updatedAt": "2021-10-14T05:40:55.997Z"
}
}