post https://demo2.progressivelp.com/Progressive.B2BAPI.Orchestrator/api/v1/application/cart
Submits merchant cart, processes cart, and returns cart pricing.
Request Fields
Field | Definition | Required | Datatype | Rules | Examples |
---|---|---|---|---|---|
store | An object that contains the details of the Merchant and their Store | Object | |||
store.progressiveMerchantId | The Progressive supplied ID that designates your Progressive store number. | Integer | |||
store.merchantStoreId | This value is supplied by your organization. It is the value from your system which represents an individual store location. This information must be cross referenced to the Progressive System. | String | |||
store.salesAssociate | Store sales associate name/ID that is entering the lease application. | String | |||
store.merchantApplicationIdentifier | This is a store-specific field for passing a Merchant application's unique identifier. | Optional | String | ||
store.merchantTerminalId | Store terminal Id number, to be used in scenarios where a store's POS system is interacting with the endpoint. | Optional | String | ||
applicationId | This is the Account Number (AKA Lease ID) as assigned by Progressive Leasing | String | |||
merchantTransactionId | This is the Invoice Number or other ID from the Merchant's system | String | |||
deposit | Not Implemented. Will provide future functionality. | Not Implemented | Number | ||
cartTotal | The sum of all LineItem's "LineTotal" amounts in the cart. | Number | |||
items | A collection of products that are present in the customer's cart. The item collection can contain 1..* items | Array of Object | |||
items[0].lineNumber | A unique line number assigned to each item in the collection. Note - the index of the item is denoted in brackets - e.g. the first ordinal item record in the collection is [0] (zero-based). | Integer | |||
items[0].sku | An item identifier, typically assigned by the manufacturer or retailer | String | |||
items[0].model | A description of the individual variant of this particular item. A single item may come in multiple models | String | |||
items[0].description | A human readable description of the item | String | |||
items[0].priceEach | The unit price of the item | Number | |||
items[0].quantity | The number of the given line item that is being purchased | Integer | |||
items[0].lineTotal | The priceEach * quantity for the line item | Number | |||
items[0].isNew | An indication of whether the merchandise is new or used. | Boolean | Boolean | ||
items[0].type | Only one item of type "DeliveryFee" should be submitted per cart. This single item should contain the total of all delivery fee items included in the cart. Leave empty for all items other than delivery charges. | String | |||
items[0].deliveryType | An enum value that indicates the type of Delivery. Possible values are: Null, TakeWith, InStorePickUp, HomeDelivery | Optional | string | ||
items[0].deliveryLocation | Indicates the location that the customer will take delivery of the item. When provided, should be set to the MerchantStoreId of the store the item will be picked up from | Required when DeliveryType is “InStorePickUp” | String |
Response Fields
Field | Definition | Required | Datatype | Rules | Examples |
---|---|---|---|---|---|
cartId | A unique generated number representing the cart submission. | Integer |