Cancel Order

MUTATIONcancelOrder(input: CancelOrderInput!): StorefrontOrder!

Arguments

input*

Returns

cancelOrder

_id*ID!

tenant?String

invoiceUID?String

shippingAddress?

note?String

rejectionReason?String

paymentStatus?PAYMENT_STATUS

Value inPROCESSINGPAIDCANCELLEDFAILEDUNATTEMPTEDEXPIRED

invoiceStatus?INVOICE_STATUS

Value inPENDINGPROCESSINGREJECTEDCANCELLEDSHIPMENT_IN_PROGRESSSHIPMENT_IN_TRANSITSHIPMENT_DELIVERED

paymentMethod?INVOICE_PAYMENT_METHOD

Value inCODONLINE

paymentProvider?PAYMENT_PROVIDER

Value inBKASHSSLCOMMERZ

paymentTransactionId?String

paymentSuccessUrl?String

paymentFailUrl?String

paymentCancelUrl?String

paidAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

customer?

vendor?

lineItems?

subTotalAmount?Float

netTotalAmount?Float

taxRate?Float

taxAmount?Float

deliveryCharge?Float

couponCode?String

couponDiscount?Float

Total of all discounts on the order. Kept for older clients; equals discountTotal.

discountApplications?

discountTotal?Float

shippingDiscount?Float

Part of discountTotal that came off the delivery charge.

deliveryArea?String

deliverySubArea?String

webhookEvent?String

Latest Graphland PGW webhook event as JSON string. Parse with JSON.parse on the client.

createdAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

updatedAt?DateTime

A date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.

shipment?

customFields?

Example Request

mutation CancelOrder($input: CancelOrderInput!) {
  cancelOrder(input: $input) {
    _id
    tenant
    invoiceUID
    shippingAddress {
      lat
      lng
      caption
    }
    note
    rejectionReason
    paymentStatus
    invoiceStatus
    paymentMethod
    customer {
      referenceId
      name
      email
      phoneNumber
    }
  }
}

mutation CancelOrder($input: CancelOrderInput!) {  cancelOrder(input: $input) {    _id    tenant    invoiceUID    shippingAddress {      lat      lng      caption    }    note    rejectionReason    paymentStatus    invoiceStatus    paymentMethod    customer {      referenceId      name      email      phoneNumber    }  }}

Variables

{
  "input": {
    "orderId": "1"
  }
}

Variables

{  "input": {    "orderId": "1"  }}

Example Response

{
  "data": {
    "cancelOrder": {
      "_id": "1",
      "tenant": "string",
      "invoiceUID": "string",
      "shippingAddress": {
        "lat": 10.5,
        "lng": 10.5,
        "caption": "string"
      },
      "note": "string",
      "rejectionReason": "string",
      "paymentStatus": "PROCESSING",
      "invoiceStatus": "PENDING",
      "paymentMethod": "COD",
      "customer": {
        "referenceId": "1",
        "name": "string",
        "email": "string",
        "phoneNumber": "string"
      }
    }
  }
}

Example Response

{  "data": {    "cancelOrder": {      "_id": "1",      "tenant": "string",      "invoiceUID": "string",      "shippingAddress": {        "lat": 10.5,        "lng": 10.5,        "caption": "string"      },      "note": "string",      "rejectionReason": "string",      "paymentStatus": "PROCESSING",      "invoiceStatus": "PENDING",      "paymentMethod": "COD",      "customer": {        "referenceId": "1",        "name": "string",        "email": "string",        "phoneNumber": "string"      }    }  }}

ArgumentsCopy Anchor Link

ReturnsCopy Anchor Link

Arguments

Returns