Skip to main content

Generic Request Payload for all endpoints

Below is a generic request payload for all the endpoints which needs to be configured in Marketplace
follow this doc for how to create/edit: https://cmcom.atlassian.net/wiki/x/SAAukQ

  1. Customers:
{
"queryFields": "edges { node { id displayName createdAt numberOfOrders amountSpent { amount currencyCode } defaultEmailAddress { emailAddress } defaultPhoneNumber { phoneNumber } orders(first: 250) { edges { node { id name processedAt totalPrice displayFinancialStatus } } } } }"
}
  1. OrderDetails:
{
"queryFields": "edges { node { id name processedAt displayFinancialStatus displayFulfillmentStatus currentTotalPriceSet { shopMoney { amount currencyCode } } shippingLine { originalPriceSet { shopMoney { amount currencyCode } } } lineItems(first: 10) { edges { node { title quantity originalTotalSet { shopMoney { amount currencyCode } } } } } transactions(first: 5) { id status amountSet { shopMoney { amount currencyCode } } } fulfillments(first: 5) { id name status createdAt trackingInfo { number company url } fulfillmentLineItems(first: 10) { edges { node { lineItem { title quantity originalUnitPriceSet { shopMoney { amount currencyCode } } } quantity } } } } } }"
}
  1. Search:
{
"first": "",
"queryFields": "edges { node { id displayName defaultEmailAddress { emailAddress } defaultPhoneNumber { phoneNumber } createdAt numberOfOrders amountSpent { amount currencyCode } orders(first: 250) { edges { node { id name processedAt displayFinancialStatus displayFulfillmentStatus currentTotalPriceSet { shopMoney { amount currencyCode } } } } } } }"
}

you can configure the field “first” in the payload, default value is “10”

4.Orders:

{
"queryFields": "edges { node { id displayName createdAt numberOfOrders amountSpent { amount currencyCode } defaultEmailAddress { emailAddress } defaultPhoneNumber { phoneNumber } orders(first: 250) { edges { node { id name number processedAt totalPrice displayFinancialStatus } } } } }"
}