---
title: "Returns lists of canceled orders"
method: GET
path: "/orders/status/canceled"
tags: ["orders"]
---

# Returns lists of canceled orders

`GET /orders/status/canceled`

## Request

- Base URL: `https://api.brandlovers.com/marketplace/v1`
- URL: `https://api.brandlovers.com/marketplace/v1/orders/status/canceled`
- Auth: none declared. Required headers: `authorization`

Returns a list with canceled orders. Canceled orders should not be fullfiled.

## Query parameters

- `offset` integer
- `limit` integer

## Headers

- `authorization` string, required

## Response `200`

Success!

- GetOrders
  - `orders` Order[], required
    - `orderId` string, required: Unique order Id (related to this seller)
    - `orderMarketplaceId` string, required: Unique Order Id that will be displayed to the customer. This Id is not the same as `orderId`
    - `createdAt` string, date-time, required: Date that this order was created
    - `approvedAt` string, date-time: Date that this order was approved for fullfilment
    - `updatedAt` string, date-time, required: Last update data of this order
    - `status` string, required: Order status
    - `totalAmount` integer, required: Order total in cents, this is what the customer will be charged for. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
    - `totalItemsAmount` integer, required: Order items total amount in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
    - `totalShippingAmount` integer, required: Total shipments amount items. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
    - `totalDiscountAmount` integer, required: Total order discounts in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
    - `billingAddress` Address, required
      - `address` string, required: Address first line (ave, street name, etc..)
      - `number` string, required: Address number
      - `complement` string, required: Complementary info (aptartament number, building name, suite)
      - `neighbourhood` string, required: Address neighbourhood
      - `reference` string: Pontos de referência
      - `city` string, required: City
      - `state` string, required: State
      - `countryId` string, required: Contry code using aplpha ISO-3166, Example: BR, US, AR, GB, CN
      - `zipCode` string, required: Zip Code
      - `recipientName` string: Recipient Name
    - `customer` Customer, required
      - `id` string, required: Customer unqiue Id
      - `name` string, required: Customer Name
      - `documentNumber` string, required: Customer tax information
      - `type` string, required: Customer type: Enterprise or Consumer
      - `email` string: Customer Email (when available). Please note: Email is not a mandatory field
      - `phones` Phone[], required: Customer phone number
        - `number` string, required: Phone number
        - `type` string, required: Phone number type, home, office, mobile, etc
    - `freight` Freight, required
      - `defaultAmount` integer, required: Default value of this shippment.
      - `chargedAmount` integer, required: Shipment cost. Must be informed in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. Same as $1,2345.67 must be informed solely as 1234567
      - `transitTime` integer, required: Deliver time in seconds. Time must be provided in seconds. For example 1 day should be informed as 86400. This time will be included in the product ETA informed to the customer
      - `crossDockingTime` integer, required: Time it will take to manufacture, prepare or setup this product. Time must be provided in seconds. For example 1 day should be informed as 86400. This time will be included in the product ETA informed to the customer
      - `additionalInfo` string, required: Aditional information for the courier
      - `type` string: Freight type
      - `ETA` string, date-time: Estimated time of arrival
      - `scheduledPeriod` string: Scheduled period
    - `items` OrderItem[], required
      - `id` string, required: Unique Id representing this item
      - `skuSellerId` string, required: Unique Product Id (SKU) in the seller system
      - `name` string, required: Product name
      - `salePrice` integer, required: Product unit price
      - `sent` boolean, required: Flag if product was already shipped
      - `freight` Freight, required
        - `defaultAmount` integer, required: Default value of this shippment.
        - `chargedAmount` integer, required: Shipment cost. Must be informed in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. Same as $1,2345.67 must be informed solely as 1234567
        - `transitTime` integer, required: Deliver time in seconds. Time must be provided in seconds. For example 1 day should be informed as 86400. This time will be included in the product ETA informed to the customer
        - `crossDockingTime` integer, required: Time it will take to manufacture, prepare or setup this product. Time must be provided in seconds. For example 1 day should be informed as 86400. This time will be included in the product ETA informed to the customer
        - `additionalInfo` string, required: Aditional information for the courier
        - `type` string: Freight type
        - `ETA` string, date-time: Estimated time of arrival
        - `scheduledPeriod` string: Scheduled period
      - `giftWrap` OrderGiftWrap
        - `available` boolean, required: Defines if giftwrpping is available for this product.
        - `value` integer, required: Amount charged for gift wrap. All prices must be provided in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
        - `messageSupport` boolean: Defines if giftwrpping is available for this product.
        - `giftCard` GiftCard
          - `from` string, required: Giftcard `from` field
          - `to` string, required: Giftcard `to` field
          - `message` string, required: Giftcard `body` message
      - `promotions` Promotion[]: Promotions array
        - `id` string, required: Promotion unique idenfitcation number
        - `name` string: Promotion name
        - `amount` integer: Total discount in cents. No commas or periods are accepeted. For example one dollar should be informed as 100. $1,2345.67 should be informed solely as 1234567
        - `type` string: Promotion type
    - `shippingAddress` Address, required
      - `address` string, required: Address first line (ave, street name, etc..)
      - `number` string, required: Address number
      - `complement` string, required: Complementary info (aptartament number, building name, suite)
      - `neighbourhood` string, required: Address neighbourhood
      - `reference` string: Pontos de referência
      - `city` string, required: City
      - `state` string, required: State
      - `countryId` string, required: Contry code using aplpha ISO-3166, Example: BR, US, AR, GB, CN
      - `zipCode` string, required: Zip Code
      - `recipientName` string: Recipient Name
    - `shipments` Shippment[], required
      - `items` OrderItemReference[], required: List of items of this shippment
        - `skuSellerId` string, required: Unique Product Id (SKU) in the seller system. This is the key that defines witch product will be updated
        - `quantity` integer, required: Quantity of items
      - `status` string, required: Shipment status
      - `description` string: Additinal shipment tracking information
      - `occurredAt` string, date-time, required: Date time when this shippment happened
      - `trackingUrl` string: Courier tracking URL
      - `number` string: Courier unique trackign Id associated with this shipment
      - `id` string: Shipment Id associated with this shippment used to group diferent item or items from a single order
      - `sellerShipmentId` string, required: Unique Seller shipment Id. This must be unique across all orders and shipments
      - `cte` string: Conhecimento de Transporte Eletrônico
      - `courier` Courier, required
        - `name` string, required: Courier name
        - `taxID` string: Courier taxId information. For example CNPJ
      - `invoice` Invoice, required
        - `cnpj` string: CNPJ responsável pelo envio dos produtos. Pode ser diferente caso a empresa possua diversos Centros de Distribuição (CDs)
        - `number` string, required: Número da Nota Fiscal
        - `serie` string, required: Número de serie da Nota Fiscal
        - `issuedAt` string, date-time: Data de emissão da Nota Fiscal
        - `accessKey` string, required: Número da chave de acesso à nota fiscal. A chave possui 44 dígitos e contém todas as informações da DANFE
        - `linkXml` string: Url para consulta da NFE
        - `linkDanfe` string: Url para consulta da DANFE
    - `seller` Seller
      - `id` string: Seller unique Id in the Brand Lovers Marketplace
      - `name` string: Seller name in the Brand Lovers Marketplace
  - `metadata` Metadata[], required
    - `key` string, required: JSON attribute key
    - `value` string, required: JSON object value

## Other responses

- `400`: Bad request.
- `401`: Access denied. You're not authenticated or token expired. Check your request header the `authorization` field is required.
- `403`: Server refused to process your request. Please check the API SLA and reduce number of requests per second.

---

[API](https://skmtc.dev/brandlovers/apis/brandlovers-marketplace-api-v1.md) - [All operations](https://skmtc.dev/brandlovers/apis/brandlovers-marketplace-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/brandlovers/apis/brandlovers-marketplace-api-v1/revisions/cb3af6151ae4?raw)
