Order checkout

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/checkout \
  --header 'Content-Type: application/json' \
  --data '
{
  "cartId": "5e4876e10cfe1d8902005d33",
  "customerEmail": "[email protected]",
  "paymentDetails": [
    {
      "transactionDetails": {
        "paymentType": "CARD",
        "tokenizedPaymentMethod": "12fyg3fv4dbb56bbd7dfb890123456",
        "cardNumber": "1234567890123456",
        "expDate": "0220",
        "cvv": "123",
        "cardHolderFullName": "Mr John Smith",
        "metadata": {}
      },
      "paymentMethod": "Visa",
      "paymentKind": "<string>",
      "amount": 533.33,
      "currency": "USD",
      "billToAddress": {
        "name": {
          "first": "John",
          "last": "Smith",
          "middle": "Paul"
        },
        "email": "[email protected]",
        "street1": "10400 NE 4th St",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": "98004",
        "phone": {
          "number": "123-456-7890",
          "kind": "Mobile"
        },
        "street2": "Suite 500",
        "kind": "Bill to address"
      },
      "billToId": 1000001,
      "shipToId": [
        1000001,
        1000002
      ],
      "conversion": 1.12
    }
  ],
  "estimatedTax": {
    "itemsTaxes": [
      {
        "lineItemId": 2,
        "amount": 20
      }
    ],
    "shipToTaxes": [
      {
        "shipToId": "5ec35a857e6cac8d99a57d3b",
        "amount": 20
      }
    ]
  },
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerPhoneNumber": {
    "number": "123-456-7890",
    "kind": "Mobile"
  },
  "shipFrom": {
    "street1": "10400 NE 4th St",
    "city": "Bellevue",
    "state": "WA",
    "country": "USA",
    "zipCode": "98004"
  }
}
'

{
  "checkoutComplete": true,
  "orderId": "9376-1544-24209"
}

POST

api-order

checkout

Order checkout

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/checkout \
  --header 'Content-Type: application/json' \
  --data '
{
  "cartId": "5e4876e10cfe1d8902005d33",
  "customerEmail": "[email protected]",
  "paymentDetails": [
    {
      "transactionDetails": {
        "paymentType": "CARD",
        "tokenizedPaymentMethod": "12fyg3fv4dbb56bbd7dfb890123456",
        "cardNumber": "1234567890123456",
        "expDate": "0220",
        "cvv": "123",
        "cardHolderFullName": "Mr John Smith",
        "metadata": {}
      },
      "paymentMethod": "Visa",
      "paymentKind": "<string>",
      "amount": 533.33,
      "currency": "USD",
      "billToAddress": {
        "name": {
          "first": "John",
          "last": "Smith",
          "middle": "Paul"
        },
        "email": "[email protected]",
        "street1": "10400 NE 4th St",
        "city": "Bellevue",
        "state": "WA",
        "country": "USA",
        "zipCode": "98004",
        "phone": {
          "number": "123-456-7890",
          "kind": "Mobile"
        },
        "street2": "Suite 500",
        "kind": "Bill to address"
      },
      "billToId": 1000001,
      "shipToId": [
        1000001,
        1000002
      ],
      "conversion": 1.12
    }
  ],
  "estimatedTax": {
    "itemsTaxes": [
      {
        "lineItemId": 2,
        "amount": 20
      }
    ],
    "shipToTaxes": [
      {
        "shipToId": "5ec35a857e6cac8d99a57d3b",
        "amount": 20
      }
    ]
  },
  "customerAccountId": "5e3598e3007c5e00080d2bb8",
  "customerPhoneNumber": {
    "number": "123-456-7890",
    "kind": "Mobile"
  },
  "shipFrom": {
    "street1": "10400 NE 4th St",
    "city": "Bellevue",
    "state": "WA",
    "country": "USA",
    "zipCode": "98004"
  }
}
'

{
  "checkoutComplete": true,
  "orderId": "9376-1544-24209"
}

Headers

x-api-key

string

Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Body

application/json

Option 1
Option 2

cartId

string

required

Required string length: 24

Example:

"5e4876e10cfe1d8902005d33"

customerEmail

string<email>

required

Minimum string length: 3

paymentDetails

object[]

required

Minimum array length: 1

Show child attributes

paymentDetails.transactionDetails

object

required

Option 1
Option 2

Show child attributes

paymentDetails.transactionDetails.paymentType

enum<string>

required

Available options:

CARD,

NON_CARD

Required string length: 4 - 8

Example:

"CARD"

paymentDetails.transactionDetails.tokenizedPaymentMethod

string

required

Example:

"12fyg3fv4dbb56bbd7dfb890123456"

paymentDetails.transactionDetails.cardNumber

string

Required string length: 13 - 19

Example:

"1234567890123456"

paymentDetails.transactionDetails.expDate

string

Required string length: 4

Example:

"0220"

paymentDetails.transactionDetails.cvv

string

Required string length: 3 - 4

Example:

"123"

paymentDetails.transactionDetails.cardHolderFullName

string

Maximum string length: 100

Example:

"Mr John Smith"

paymentDetails.transactionDetails.metadata

object

paymentDetails.paymentMethod

string

required

Minimum string length: 2

Example:

"Visa"

paymentDetails.paymentKind

string

required

paymentDetails.amount

number

required

Required range: x >= 0

Example:

533.33

paymentDetails.currency

string

required

Required string length: 3

Example:

"USD"

paymentDetails.billToAddress

object

required

Show child attributes

paymentDetails.billToAddress.name

object

required

Show child attributes

paymentDetails.billToAddress.name.first

string

required

Required string length: 2 - 50

Example:

"John"

paymentDetails.billToAddress.name.last

string

required

Required string length: 2 - 50

Example:

"Smith"

paymentDetails.billToAddress.name.middle

string

Required string length: 1 - 50

Example:

"Paul"

paymentDetails.billToAddress.email

string<email>

required

Minimum string length: 3

Example:

"[email protected]"

paymentDetails.billToAddress.street1

string

required

Example:

"10400 NE 4th St"

paymentDetails.billToAddress.city

string

required

Minimum string length: 2

Example:

"Bellevue"

paymentDetails.billToAddress.state

string

required

Minimum string length: 2

Example:

"WA"

paymentDetails.billToAddress.country

string

required

Minimum string length: 2

Example:

"USA"

paymentDetails.billToAddress.zipCode

string

required

Minimum string length: 2

Example:

"98004"

paymentDetails.billToAddress.phone

object

Show child attributes

paymentDetails.billToAddress.phone.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

paymentDetails.billToAddress.phone.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

paymentDetails.billToAddress.street2

string

Example:

"Suite 500"

paymentDetails.billToAddress.kind

string

Example:

"Bill to address"

paymentDetails.billToId

number

Example:

1000001

paymentDetails.shipToId

number[]

Minimum array length: 1

Example:

[1000001, 1000002]

paymentDetails.conversion

number

default:1

Example:

1.12

estimatedTax

object

required

Show child attributes

estimatedTax.itemsTaxes

object[]

required

Minimum array length: 1

Show child attributes

estimatedTax.itemsTaxes.lineItemId

number

required

Required range: x >= 1

Example:

2

estimatedTax.itemsTaxes.amount

number

required

Required range: x >= 0

Example:

20

estimatedTax.shipToTaxes

object[]

required

Minimum array length: 1

Show child attributes

estimatedTax.shipToTaxes.shipToId

string

required

Required string length: 24

Example:

"5ec35a857e6cac8d99a57d3b"

estimatedTax.shipToTaxes.amount

number

required

Required range: x >= 0

Example:

20

customerAccountId

string

Minimum string length: 3

Example:

"5e3598e3007c5e00080d2bb8"

customerPhoneNumber

object

Show child attributes

customerPhoneNumber.number

string

required

Required string length: 5 - 25

Example:

"123-456-7890"

customerPhoneNumber.kind

string

required

Required string length: 3 - 25

Example:

"Mobile"

shipFrom

object

Show child attributes

shipFrom.street1

string

required

Example:

"10400 NE 4th St"

shipFrom.city

string

required

Minimum string length: 2

Example:

"Bellevue"

shipFrom.state

string

required

Minimum string length: 2

Example:

"WA"

shipFrom.country

string

required

Minimum string length: 2

Example:

"USA"

shipFrom.zipCode

string

required

Minimum string length: 2

Example:

"98004"

Response

Order checkout

checkoutComplete

boolean

Example:

true

orderId

string

Example:

"9376-1544-24209"

Return order by user Add shipment to order

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Order checkout

Headers

Body

Response