---
updatedAt: 2025-09-23T23:31:36.000Z
agentTools:
  projectIndex: https://docs.creditkey.com/v1.2/llms.txt
---

# get

Retrieve details and status on an order within Credit Key.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Credit Key Merchant API",
    "description": "Credit Key Merchant Integration API",
    "contact": {
      "name": "Credit Key Support",
      "url": "https://www.creditkey.com/support",
      "email": "support@creditkey.com"
    },
    "version": "1.1.4"
  },
  "servers": [
    {
      "url": "https://staging.creditkey.com/app/ecomm"
    },
    {
      "url": "https://www.creditkey.com/app/ecomm"
    }
  ],
  "paths": {
    "/find_order": {
      "get": {
        "description": "Retrieve details and status on an order within Credit Key.",
        "parameters": [
          {
            "name": "public_key",
            "in": "query",
            "description": "The public key provided to you by Credit Key.  This varies between staging and production environments.",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "shared_secret",
            "in": "query",
            "description": "The shared secret provided to you by Credit Key.  This varies between staging and production environments.",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "The unique order key generated by Credit Key for a Merchant order as returned by `/begin_checkout`.",
            "required": true,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/order_response"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized.  The public_key and/or shared_secret given are invalid."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "address": {
        "required": [
          "address1",
          "city",
          "first_name",
          "last_name",
          "state",
          "zip"
        ],
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "example": "Joe"
          },
          "last_name": {
            "type": "string",
            "example": "Buyer"
          },
          "company_name": {
            "type": "string",
            "example": "Big Business Inc."
          },
          "email": {
            "type": "string",
            "example": "joebuyer@bigbiz.com"
          },
          "address1": {
            "type": "string",
            "example": "1600 Main St"
          },
          "address2": {
            "type": "string",
            "example": "Suite 100"
          },
          "city": {
            "type": "string",
            "example": "Los Angeles"
          },
          "state": {
            "type": "string",
            "example": "CA"
          },
          "zip": {
            "type": "string",
            "example": "90291"
          },
          "phone_number": {
            "type": "string",
            "example": "(310) 555-1212"
          }
        }
      },
      "charges": {
        "required": [
          "grand_total",
          "total"
        ],
        "type": "object",
        "properties": {
          "total": {
            "type": "number",
            "description": "The subtotal amount for all products in the cart, not including shipping, tax, or discounts.",
            "format": "decimal",
            "example": 100
          },
          "shipping": {
            "type": "number",
            "description": "The amount charged for shipping.",
            "format": "decimal",
            "example": 10
          },
          "tax": {
            "type": "number",
            "description": "The amount charged for tax.",
            "format": "decimal",
            "example": 15
          },
          "discount_amount": {
            "type": "number",
            "description": "The amount of any discounts and/or coupons applied, represented as a positive decimal.",
            "format": "decimal",
            "example": 20
          },
          "grand_total": {
            "type": "number",
            "description": "The grand total, which should be equal to total + shipping + tax - discount_amount.",
            "format": "decimal",
            "example": 105
          }
        }
      },
      "order_item": {
        "required": [
          "name",
          "price"
        ],
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "The human-readable name of the item purchased",
            "example": "Apple IIe Computer"
          },
          "price": {
            "type": "number",
            "description": "The amount of a single item.",
            "format": "decimal",
            "example": 2495.99
          },
          "sku": {
            "type": "string",
            "description": "The SKU of the item.",
            "example": "EXAMPLE-1234-A"
          },
          "merchant_produt_id": {
            "type": "string",
            "description": "The product ID in ther merchant's system.",
            "example": "1001"
          },
          "size": {
            "type": "string",
            "description": "Size of the item",
            "example": "Large"
          },
          "color": {
            "type": "string",
            "description": "Color of the item",
            "example": "Beige"
          },
          "quantity": {
            "type": "integer",
            "description": "The quantity of this SKU purchased.",
            "example": 1
          }
        }
      },
      "order_response": {
        "required": [
          "amount",
          "capture_status",
          "id",
          "items",
          "merchant_order_id",
          "merchant_status",
          "status"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique order key generated by Credit Key for a Merchant order as returned by `/begin_checkout`.",
            "example": "CK-ABC1234"
          },
          "amount": {
            "type": "number",
            "description": "The grand total amount for the order, not including any refunds given.",
            "format": "decimal",
            "example": 99.95
          },
          "refunded_amount": {
            "type": "number",
            "description": "The amount refunded for this order, if any.",
            "format": "decimal",
            "example": 5
          },
          "status": {
            "type": "string",
            "description": "The status for this order; 'placed', 'shipped', 'canceled', or 'returned'.",
            "example": "placed"
          },
          "capture_status": {
            "type": "string",
            "description": "The capture status; 'authorized', 'captured', or 'voided'.",
            "example": "captured"
          },
          "merchant_order_id": {
            "type": "string",
            "description": "The order ID in the merchant's system.",
            "example": "ORD123456"
          },
          "merchant_status": {
            "type": "string",
            "description": "The merchant's status for this order.",
            "example": "shipped"
          },
          "shipping_address": {
            "$ref": "#/components/schemas/address"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/order_item"
            }
          },
          "charges": {
            "$ref": "#/components/schemas/charges"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```