Query
query QueryPaymentsBySalesOrderId($salesOrderId: ID!) {
QueryPaymentsBySalesOrderId(salesOrderId: $salesOrderId) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
id
externalTransactionId
salesOrderId
salesInvoiceId
}
}
nodes {
id
externalTransactionId
salesOrderId
salesInvoiceId
}
totalCount
}
}Variables
{
"salesOrderId": "id"
}Response
{
"data": {
"QueryPaymentsBySalesOrderId": {
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"externalTransactionId": "string",
"salesOrderId": "id",
"salesInvoiceId": "id"
}
}
],
"nodes": [
{
"id": "id",
"externalTransactionId": "string",
"salesOrderId": "id",
"salesInvoiceId": "id"
}
],
"totalCount": 1
}
}
}Queries
QueryPaymentsBySalesOrderId
Query for sales order payments. Payments that are only linked via a sales invoice associated with the sales order are returned only if IncludeInvoicePayments is true.
QUERY
QueryPaymentsBySalesOrderId(salesOrderId: ID!, includeInvoicePayments: Boolean, first: Int, after: String, last: Int, before: String, where: PaymentFilterInput, order: [PaymentSortInput!]): QueryPaymentsBySalesOrderIdConnectionArguments
salesOrderId
ID!
required
includeInvoicePayments
Boolean
first
Int
Returns the first n elements from the list.
after
String
Returns the elements in the list that come after the specified cursor.
last
Int
Returns the last n elements from the list.
before
String
Returns the elements in the list that come before the specified cursor.
where
order
pageInfo
Information to aid in pagination.
edges
A list of edges.
nodes
[Payment!]
A flattened list of the nodes.
totalCount
Int!
Identifies the total count of items in the connection.
Query
query QueryPaymentsBySalesOrderId($salesOrderId: ID!) {
QueryPaymentsBySalesOrderId(salesOrderId: $salesOrderId) {
pageInfo {
hasNextPage
hasPreviousPage
startCursor
endCursor
}
edges {
cursor
node {
id
externalTransactionId
salesOrderId
salesInvoiceId
}
}
nodes {
id
externalTransactionId
salesOrderId
salesInvoiceId
}
totalCount
}
}Variables
{
"salesOrderId": "id"
}Response
{
"data": {
"QueryPaymentsBySalesOrderId": {
"pageInfo": {
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"id": "id",
"externalTransactionId": "string",
"salesOrderId": "id",
"salesInvoiceId": "id"
}
}
],
"nodes": [
{
"id": "id",
"externalTransactionId": "string",
"salesOrderId": "id",
"salesInvoiceId": "id"
}
],
"totalCount": 1
}
}
}Was this page helpful?