Based on the content of a customer’s shopping cart, the Katapult API can return a preview of the customer’s initial payment at checkout as well as their subsequent monthly payments.

Requested Attributes

Attribute

Data Type

Description

Required Format

state

string

customer's billing state

2 char state abbrev.

item_type

string

condition of the merchandise being added to the cart

result possibilities

quantity

integer

number of a speicfic item in the cart

number

retailer_price

string

retail price of one unit of an item

number

item_code

string

retailer defined and specific stock keeping unit to identify the product/item in the cart

none

item_name

string

name of the item in the cart

none

price

string

price of warranty

number

name

string

name of warranty

none

code

string

sku of warranty

none

leasable

boolean

indication if the warranty is leasable or not

true / false

delivery_method

string

indication of product delivery

result possibilities

shipping

string

$ amount of shipping on an item

number

zipcode

string

customer's billing zip code

5 digit

Requested Payload

{
  "state":"NY",
  "items":[{
    "item_type":"new"
        "quantity":1,
        "retailer_price":500
        "item_code":"ukz637",
    "item_name":"samsung tv",
        "warranty":{
      "price":100,
            "name":"warranty name",
        "code":"warranty sku"
    },
        "leasable":true
  }],
    "delivery_method": "delivery",
    "shipping":10,
    "zipcode": "10010"
}

Preview Lease Pricing

Errors

HTTP status

Description

NOT FOUND

404

Invalid state

INTERNAL SERVER ERROR

500

Invalid Request Payload

UNAUTHORIZED

401

Invalid Authorization Token

Language
Authentication
Bearer
URL