BigCommerce · Example Payload

Bigcommerce Createorderrefund Example

E-CommerceRetailCatalogOrdersCheckoutPaymentsSaaS

Bigcommerce Createorderrefund Example is an example object payload from BigCommerce, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createOrderRefund",
  "method": "POST",
  "path": "/orders/{order_id}/payment_actions/refunds",
  "summary": "BigCommerce Create a Refund",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "422",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "data": [
          {
            "status": 422,
            "title": "Unable to provide store credit for a guest customer.",
            "type": "https://developer.bigcommerce.com/api-docs/getting-started/api-status-codes"
          }
        ]
      }
    },
    {
      "status": "503",
      "contentType": "application/json",
      "name": "response",
      "example": {
        "data": [
          {
            "order_id": 1,
            "status": 503,
            "error": "Tax service gone away"
          }
        ],
        "meta": {}
      }
    }
  ]
}