Return payment by orderId

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/payment \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orders": [
    "4809-7758-87594"
  ]
}
'

{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 2
  },
  "orders": [
    {
      "_id": "61160edde8af410009827c28",
      "isSugarRefunded": true,
      "tags": "<array>",
      "cartId": "61160ddbffac450008316d70",
      "attributes": "<array>",
      "customerEmail": "[email protected]",
      "orderCurrency": "USD",
      "orderTotal": 6011.99,
      "taxTotal": 0,
      "channel": 12,
      "status": "ORDER_CREATED",
      "statusLog": "Order has been created",
      "orderReference": "3635-1613-42753",
      "orderId": "4809-7758-87594",
      "shipTo": [
        {
          "address": {
            "name": {
              "first": "First",
              "last": "Last"
            },
            "phone": {
              "number": "123-992-9404",
              "kind": "Mobile"
            },
            "street1": "888 Broadway",
            "city": "New York",
            "state": "NY",
            "country": "United States",
            "zipCode": 10003,
            "kind": "shipping",
            "email": "[email protected]"
          },
          "delivery": {
            "actual": "<string>"
          },
          "shipping": {
            "actual": "<string>"
          },
          "promosApplied": "<array>",
          "_id": "61160dea8e37e00008266191",
          "shipToType": "SHIP_TO_ADDRESS",
          "taxCode": "FR1000",
          "shipToId": 1499,
          "price": 11.99,
          "shipmentMethodId": 10002,
          "estimatedTax": 0,
          "shipmentCarrier": "2 Day",
          "total": 11.99,
          "readyForPickups": "<array>",
          "id": "61160dea8e37e00008266191"
        }
      ],
      "items": [
        {
          "group": [
            1.2312312312312322e+23
          ],
          "promosApplied": "<array>",
          "_id": "61160ddbffac450008316d71",
          "price": 600,
          "weightUnit": "kg",
          "isPickup": true,
          "itemId": 1000011164,
          "quantity": 10,
          "priceListId": 100000,
          "sku": "BLUETEST",
          "taxCode": "PH060771",
          "title": "Loki Cat",
          "weight": 7,
          "lineItemId": 1,
          "attributeTotalPrice": 0,
          "attributes": "<array>",
          "currency": "USD",
          "shipToId": 1499,
          "discount": 0,
          "estimatedTax": 0,
          "total": 6000,
          "reservedLocation": "<array>",
          "id": "61160ddbffac450008316d71"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToAddress": {
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": 7780811973,
              "kind": "mobile"
            },
            "email": "[email protected]",
            "street1": "600 Congress Ave",
            "street2": "suite 219",
            "city": "Austin",
            "state": "Tx",
            "country": "US",
            "zipCode": 10033
          },
          "shipToId": [
            1499
          ],
          "_id": "61160edde8af410009827c2b",
          "paymentStatus": "authorized",
          "amount": 5000,
          "currency": "USD",
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "visa",
          "paymentKind": "CARD_STRIPE",
          "conversion": 1,
          "paymentToken": {
            "token": "pi_3JNthOJxr7zyIFb91Tp0jQTG",
            "type": "CARD_STRIPE"
          },
          "id": "61160edde8af410009827c2b"
        }
      ],
      "revision": 0,
      "totalQuantity": 10,
      "statusDescriptions": "<array>",
      "events": "<array>",
      "pickups": "<array>",
      "createdAt": "2021-08-13T06:19:09.589Z",
      "updatedAt": "2021-08-13T06:19:09.589Z",
      "__v": 0
    }
  ]
}

POST

api-order

orders

payment

Return payment by orderId

curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-order/orders/payment \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "orders": [
    "4809-7758-87594"
  ]
}
'

{
  "query": {
    "limit": 10,
    "offset": 0,
    "count": 2
  },
  "orders": [
    {
      "_id": "61160edde8af410009827c28",
      "isSugarRefunded": true,
      "tags": "<array>",
      "cartId": "61160ddbffac450008316d70",
      "attributes": "<array>",
      "customerEmail": "[email protected]",
      "orderCurrency": "USD",
      "orderTotal": 6011.99,
      "taxTotal": 0,
      "channel": 12,
      "status": "ORDER_CREATED",
      "statusLog": "Order has been created",
      "orderReference": "3635-1613-42753",
      "orderId": "4809-7758-87594",
      "shipTo": [
        {
          "address": {
            "name": {
              "first": "First",
              "last": "Last"
            },
            "phone": {
              "number": "123-992-9404",
              "kind": "Mobile"
            },
            "street1": "888 Broadway",
            "city": "New York",
            "state": "NY",
            "country": "United States",
            "zipCode": 10003,
            "kind": "shipping",
            "email": "[email protected]"
          },
          "delivery": {
            "actual": "<string>"
          },
          "shipping": {
            "actual": "<string>"
          },
          "promosApplied": "<array>",
          "_id": "61160dea8e37e00008266191",
          "shipToType": "SHIP_TO_ADDRESS",
          "taxCode": "FR1000",
          "shipToId": 1499,
          "price": 11.99,
          "shipmentMethodId": 10002,
          "estimatedTax": 0,
          "shipmentCarrier": "2 Day",
          "total": 11.99,
          "readyForPickups": "<array>",
          "id": "61160dea8e37e00008266191"
        }
      ],
      "items": [
        {
          "group": [
            1.2312312312312322e+23
          ],
          "promosApplied": "<array>",
          "_id": "61160ddbffac450008316d71",
          "price": 600,
          "weightUnit": "kg",
          "isPickup": true,
          "itemId": 1000011164,
          "quantity": 10,
          "priceListId": 100000,
          "sku": "BLUETEST",
          "taxCode": "PH060771",
          "title": "Loki Cat",
          "weight": 7,
          "lineItemId": 1,
          "attributeTotalPrice": 0,
          "attributes": "<array>",
          "currency": "USD",
          "shipToId": 1499,
          "discount": 0,
          "estimatedTax": 0,
          "total": 6000,
          "reservedLocation": "<array>",
          "id": "61160ddbffac450008316d71"
        }
      ],
      "shipments": "<array>",
      "payments": [
        {
          "billToAddress": {
            "name": {
              "first": "John",
              "last": "Smith"
            },
            "phone": {
              "number": 7780811973,
              "kind": "mobile"
            },
            "email": "[email protected]",
            "street1": "600 Congress Ave",
            "street2": "suite 219",
            "city": "Austin",
            "state": "Tx",
            "country": "US",
            "zipCode": 10033
          },
          "shipToId": [
            1499
          ],
          "_id": "61160edde8af410009827c2b",
          "paymentStatus": "authorized",
          "amount": 5000,
          "currency": "USD",
          "paymentIdentifier": {
            "cardIdentifier": 4242
          },
          "paymentMethod": "visa",
          "paymentKind": "CARD_STRIPE",
          "conversion": 1,
          "paymentToken": {
            "token": "pi_3JNthOJxr7zyIFb91Tp0jQTG",
            "type": "CARD_STRIPE"
          },
          "id": "61160edde8af410009827c2b"
        }
      ],
      "revision": 0,
      "totalQuantity": 10,
      "statusDescriptions": "<array>",
      "events": "<array>",
      "pickups": "<array>",
      "createdAt": "2021-08-13T06:19:09.589Z",
      "updatedAt": "2021-08-13T06:19:09.589Z",
      "__v": 0
    }
  ]
}

Headers

x-api-key

string

Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

Pagination parameters

object

Show child attributes

Pagination parameters.offset

integer

default:0

Required range: x >= 0

Pagination parameters.limit

integer

default:10

Required range: x >= 1

Body

application/json

orders

string[]

Response

returned orders

query

object

Show child attributes

query.limit

number

Example:

10

query.offset

number

Example:

0

query.count

number

Example:

2

orders

object[]

Show child attributes

orders._id

string

Example:

"61160edde8af410009827c28"

orders.isSugarRefunded

boolean

orders.tags

array

orders.cartId

string

Example:

"61160ddbffac450008316d70"

orders.attributes

array

orders.customerEmail

string

Example:

"[email protected]"

orders.orderCurrency

string

Example:

"USD"

orders.orderTotal

number

Example:

6011.99

orders.taxTotal

number

Example:

0

orders.channel

number

Example:

12

orders.status

string

Example:

"ORDER_CREATED"

orders.statusLog

string

Example:

"Order has been created"

orders.orderReference

string

Example:

"3635-1613-42753"

orders.orderId

string

Example:

"4809-7758-87594"

orders.shipTo

object[]

Show child attributes

orders.shipTo.address

object

Show child attributes

orders.shipTo.address.name

object

Show child attributes

orders.shipTo.address.name.first

string

Example:

"First"

orders.shipTo.address.name.last

string

Example:

"Last"

orders.shipTo.address.phone

object

Show child attributes

orders.shipTo.address.phone.number

string

Example:

"123-992-9404"

orders.shipTo.address.phone.kind

string

Example:

"Mobile"

orders.shipTo.address.street1

string

Example:

"888 Broadway"

orders.shipTo.address.city

string

Example:

"New York"

orders.shipTo.address.state

string

Example:

"NY"

orders.shipTo.address.country

string

Example:

"United States"

orders.shipTo.address.zipCode

string

Example:

10003

orders.shipTo.address.kind

string

Example:

"shipping"

orders.shipTo.address.email

string

Example:

"[email protected]"

orders.shipTo.delivery

object

Show child attributes

orders.shipTo.delivery.actual

string<nullable>

orders.shipTo.shipping

object

Show child attributes

orders.shipTo.shipping.actual

string<nullable>

orders.shipTo.promosApplied

array

orders.shipTo._id

string

Example:

"61160dea8e37e00008266191"

orders.shipTo.shipToType

string

Example:

"SHIP_TO_ADDRESS"

orders.shipTo.taxCode

string

Example:

"FR1000"

orders.shipTo.shipToId

number

Example:

1499

orders.shipTo.price

number

Example:

11.99

orders.shipTo.shipmentMethodId

string

Example:

10002

orders.shipTo.estimatedTax

number

Example:

0

orders.shipTo.shipmentCarrier

string

Example:

"2 Day"

orders.shipTo.total

number

Example:

11.99

orders.shipTo.readyForPickups

array

orders.shipTo.id

string

Example:

"61160dea8e37e00008266191"

orders.items

object[]

Show child attributes

orders.items.group

string[]

orders.items.promosApplied

array

orders.items._id

string

Example:

"61160ddbffac450008316d71"

orders.items.price

number

Example:

600

orders.items.weightUnit

string

Example:

"kg"

orders.items.isPickup

boolean

orders.items.itemId

number

Example:

1000011164

orders.items.quantity

number

Example:

10

orders.items.priceListId

number

Example:

100000

orders.items.sku

string

Example:

"BLUETEST"

orders.items.taxCode

string

Example:

"PH060771"

orders.items.title

string

Example:

"Loki Cat"

orders.items.weight

number

Example:

7

orders.items.lineItemId

number

Example:

1

orders.items.attributeTotalPrice

number

Example:

0

orders.items.attributes

array

orders.items.currency

string

Example:

"USD"

orders.items.shipToId

number

Example:

1499

orders.items.discount

number

Example:

0

orders.items.estimatedTax

number

Example:

0

orders.items.total

number

Example:

6000

orders.items.reservedLocation

array

orders.items.id

string

Example:

"61160ddbffac450008316d71"

orders.shipments

array

orders.payments

object[]

Show child attributes

orders.payments.billToAddress

object

Show child attributes

orders.payments.billToAddress.name

object

Show child attributes

orders.payments.billToAddress.name.first

string

Example:

"John"

orders.payments.billToAddress.name.last

string

Example:

"Smith"

orders.payments.billToAddress.phone

object

Show child attributes

orders.payments.billToAddress.phone.number

string

Example:

7780811973

orders.payments.billToAddress.phone.kind

string

Example:

"mobile"

orders.payments.billToAddress.email

string

Example:

"[email protected]"

orders.payments.billToAddress.street1

string

Example:

"600 Congress Ave"

orders.payments.billToAddress.street2

string

Example:

"suite 219"

orders.payments.billToAddress.city

string

Example:

"Austin"

orders.payments.billToAddress.state

string

Example:

"Tx"

orders.payments.billToAddress.country

string

Example:

"US"

orders.payments.billToAddress.zipCode

string

Example:

10033

orders.payments.shipToId

number[]

orders.payments._id

string

Example:

"61160edde8af410009827c2b"

orders.payments.paymentStatus

string

Example:

"authorized"

orders.payments.amount

number

Example:

5000

orders.payments.currency

string

Example:

"USD"

orders.payments.paymentIdentifier

object

Show child attributes

orders.payments.paymentIdentifier.cardIdentifier

string

Example:

4242

orders.payments.paymentMethod

string

Example:

"visa"

orders.payments.paymentKind

string

Example:

"CARD_STRIPE"

orders.payments.conversion

number

Example:

1

orders.payments.paymentToken

object

Show child attributes

orders.payments.paymentToken.token

string

Example:

"pi_3JNthOJxr7zyIFb91Tp0jQTG"

orders.payments.paymentToken.type

string

Example:

"CARD_STRIPE"

orders.payments.id

string

Example:

"61160edde8af410009827c2b"

orders.revision

number

Example:

0

orders.totalQuantity

number

Example:

10

orders.statusDescriptions

array

orders.events

array

orders.pickups

array

orders.createdAt

string

Example:

"2021-08-13T06:19:09.589Z"

orders.updatedAt

string

Example:

"2021-08-13T06:19:09.589Z"

orders.__v

number

Example:

0

Get order by user Cancel order by user

⌘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

Return payment by orderId

Headers

Query Parameters

Body

Response