# Get order

Use it to get order

Endpoint: GET /orders/{orderId}
Version: 1.0

## Path parameters:

  - `orderId` (string, required)

## Header parameters:

  - `x-api-key` (string, required)
    Api key provided on integrations tab in Easyflow platform.

  - `x-api-secret` (string, required)
    Api Secret provided on integrations tab in Easyflow platform.

  - `business-id` (string, required)
    Business Identifier

## Response 200 fields (application/json):

  - `statusCode` (integer)
    Example: 200

  - `data` (object)

  - `data.id` (string)

  - `data.date` (string)

  - `data.paidAt` (string)

  - `data.status` (string)
    status returning: pending, paid, canceled, reversed, refunded, charged-back, partially-paid

  - `data.orderBuyer` (object)

  - `data.orderBuyer.name` (string)

  - `data.orderBuyer.email` (string)

  - `data.orderBuyer.phone` (object)

  - `data.orderBuyer.phone.areaCode` (string)

  - `data.orderBuyer.phone.ddd` (string)

  - `data.orderBuyer.phone.number` (string)

  - `data.orderBuyer.phone.isMobile` (boolean)

  - `data.orderBuyer.address` (object)

  - `data.orderBuyer.address.zipCode` (string,null)

  - `data.orderBuyer.address.street` (string,null)

  - `data.orderBuyer.address.complement` (string,null)

  - `data.orderBuyer.address.neighborhood` (string,null)

  - `data.orderBuyer.address.city` (string,null)

  - `data.orderBuyer.address.state` (string,null)

  - `data.orderBuyer.document` (object)

  - `data.orderBuyer.document.type` (string)

  - `data.orderBuyer.deliveryAddress` (object)

  - `data.coupon` (object)

  - `data.coupon.code` (string,null)

  - `data.coupon.totalDiscountValueInCents` (integer)

  - `data.coupon.percentage` (integer)

  - `data.coupon.valueInCents` (integer)

  - `data.items` (array)

  - `data.items.product` (object)

  - `data.items.product.image` (object)

  - `data.items.product.image.path` (string)

  - `data.items.product.image.url` (string)

  - `data.items.product.image.isPublic` (boolean)

  - `data.items.product.image.extension` (string)

  - `data.items.unitValueInCents` (integer)

  - `data.items.quantity` (integer)

  - `data.items.subscription` (object)

  - `data.items.subscription.expiration` (string,null)

  - `data.items.subscription.periodicity` (string)

  - `data.items.subscription.numberRecurrences` (integer)

  - `data.items.subscription.status` (string)

  - `data.items.subscription.recurrenceValueInCents` (integer)

  - `data.items.subscription.paymentMethod` (string)

  - `data.items.subscription.repeatIndefinitely` (boolean)

  - `data.items.subscription.recurrences` (array)

  - `data.items.subscription.recurrences.billingDate` (string)

  - `data.items.subscription.recurrences.dueDate` (string)

  - `data.items.subscription.recurrences.recurrence` (integer)

  - `data.payments` (array)

  - `data.payments.payment` (object)

  - `data.payments.payment.status` (string)
    status returning: pending, in-processing, authorized, paid, partially-paid, refused, aborted, canceled, charged-back, unpaid, accepted, denied, reversed, refunded

  - `data.payments.payment.valuePaidInCents` (integer)

  - `data.payments.payment.externalId` (string,null)

  - `data.payments.payment.fineValueInCents` (integer)

  - `data.payments.payment.installments` (integer)

  - `data.payments.payment.interestValueInCents` (integer)

  - `data.payments.payment.statusHistory` (array)

## Response 400 fields (application/json):

  - `message` (string)
    Invalid param: []
    Example: "Invalid param: []"

  - `error` (string)
    Bad Request
    Example: "Bad Request"

  - `statusCode` (integer)
    400
    Example: 400

## Response 401 fields (application/json):

  - `message` (string)
    Invalid field
    Example: "Unauthorized"

  - `error` (string)
    Unauthorized
    Example: "Unauthorized"

  - `statusCode` (integer)
    401
    Example: 401

## Response 403 fields (application/json):

  - `message` (string)
    Forbidden resource
    Example: "Forbidden resource"

  - `error` (string)
    Forbidden
    Example: "Forbidden"

  - `statusCode` (integer)
    403
    Example: 403

## Response 500 fields (application/json):

  - `message` (string)
    Internal server error
    Example: "Internal server error"

  - `error` (string)
    Internal Server Error
    Example: "Internal Server Error"

  - `statusCode` (integer)
    500
    Example: 500