Pedido

(GET) por ID

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}
            

                
# Here is a curl example
curl --location \
'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "tenant": "string",
  "operator": "string",
  "createDate": "1970-01-01T00:00:00.000000",
  "lastUpdate": "1970-01-01T00:00:00.000000",
  "lastEvent": "string",
  "orderData": {
    "id": "string",
    "status": "string",
    "orderDate": "1970-01-01T00:00:00.000000",
    "notApprovalDate": "string",
    "approvalDate": "1970-01-01T00:00:00.000000",
    "cancelDate": "string",
    "marketPlaceIdOrder": "string",
    "shippingId": "string",
    "salesChannel": "string",
    "placeOfSale": "string",
    "excludeFromSellerIndex": true
  },
  "marketplaceData": {
    "marketPlaceId": "string",
    "siteId": "string",
    "marketplace": "string",
    "lastUpdate": "1970-01-01T00:00:00.000000",
    "active": true
  },
  "customerData": {
    "name": "string",
    "exemptStateRegistration": true,
    "document": "string",
    "documentType": "string",
    "gender": "string",
    "customerType": "string",
    "email": "string",
    "emailWithMask": "string",
    "addressData": {
      "type": "string",
      "zipcode": "string",
      "address": "string",
      "number": "string",
      "complement": "string",
      "reference": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "stateAcronym": "string",
      "country": "string",
      "receiverName": "string"
    },
    "phones": [
      {
        "type": "string",
        "ddi": "string",
        "ddd": "string",
        "number": "string",
        "local": "string",
        "mobile": "string",
        "telephone": "string"
      }
    ]
  },
  "invoiceData": {
    "tenant": "string",
    "operator": "string",
    "id": "string",
    "key": "string",
    "status": "string",
    "number": "string",
    "integrationNumber": "string",
    "serie": "string",
    "cfop": "string",
    "stateRegistration": "ISENTO",
    "date": "1970-01-01T00:00:00.000000",
    "linkXML": "string",
    "base64XML": "string",
    "linkDANFE": "string",
    "base64DANFE": "string",
    "typeSEFAZ": "string",
    "messageSEFAZ": "string",
    "note": "string"
  },
  "deliveryData": {
    "type": "string",
    "deliveryChannel": "string",
    "estimatedDeliveryDate": "string",
    "deliveryDate": "1970-01-01T00:00:00.000000",
    "crossdockingDays": integer,
    "trackingCode": "string",
    "trackingURL": "string",
    "shippingMethod": "string",
    "deliveryMethodId": "string",
    "deliveryMethodName": "string",
    "quotationId": "string",
    "shippingCompany": "string",
    "documentShippingCompany": "string",
    "estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
    "sentDelayed": true,
    "addressData": {
      "type": "string",
      "zipcode": "string",
      "address": "string",
      "number": "string",
      "complement": "string",
      "reference": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "stateAcronym": "string",
      "country": "string",
      "receiverName": "string"
    },
    "deliveriesExceptions": []
  },
  "shippingData": {
    "shippingDate": "1970-01-01T00:00:00.000000",
    "estimatedShippingDate": "1970-01-01T00:00:00.000000",
    "shippingCreateDate": "string",
    "shippingExpireDate": "string",
    "shippingLabel": "string",
    "shippingLabelLink": "string",
    "shippingLabelBase64": "string",
    "shippingLabelChannelLink": "string",
    "shippingLabelChannelBase64": "string",
    "address": {
      "type": "string",
      "zipcode": "string",
      "address": "string",
      "number": "string",
      "complement": "string",
      "reference": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "stateAcronym": "string",
      "country": "string",
      "receiverName": "string"
    }
  },
  "freightData": {
    "type": "string",
    "chargedValue": number,
    "shipmentChargedValue": integer,
    "transitTime": integer,
    "commercialConditionId": "string",
    "distributionCenterId": "string",
    "freightTakeRateException": "string",
    "freightTakeRate": "string",
    "freightTakeRateSeller": integer,
    "freightTakeRateType": "string",
    "freightTakeRateMarketplace": integer,
    "freightTakeRateSellerIndex": integer,
    "freightTakeRateSubsidyPercentage": integer,
    "costType": "string",
    "weightType": "string",
    "complementLimitMarketplace": integer,
    "modalType": "string",
    "excessShippingPolicy": "string",
    "sellerParticipationShippingValue": number,
    "marketplaceParticipationShippingValue": number
  },
  "orderValuesData": {
    "items": integer,
    "value": number,
    "discount": number,
    "interest": number,
    "netValue": number,
    "grossValue": number
  },
  "platformData": {
    "acronym": "string",
    "platform": "string",
    "active": true
  },
  "paymentData": {
    "responsible": "string",
    "addressData": {
      "type": "string",
      "zipcode": "string",
      "address": "string",
      "number": "string",
      "complement": "string",
      "reference": "string",
      "neighborhood": "string",
      "city": "string",
      "state": "string",
      "stateAcronym": "string",
      "country": "string",
      "receiverName": "string"
    },
    "formsPayments": [
      {
        "marketPlaceId": "string",
        "sequence": "string",
        "type": "string",
        "value": number,
        "status": "string",
        "amountPlots": integer,
        "currencies": "string",
        "flag": "string",
        "card": "string",
        "operation": "string",
        "valid": true,
        "formPaymentId": "string",
        "paymentConditionId": "string",
        "nsu": "string",
        "paymentId": "string",
        "transactionId": "string",
        "transactionStatus": "string",
        "authorizationId": "string"
      }
    ],
    "paymentMethods": []
  },
  "cancellationsData": [],
  "devolutionsData": [
    {
      "id": "string",
      "devolutionDate": "1970-01-01T00:00:00.000000",
      "reason": "string",
      "reasonId": "string",
      "description": "string",
      "moveStock": true,
      "returnedItems": [
        {
          "tenant": null,
          "skuData": {
            "id": "string",
            "sku": "string",
            "productType": "string",
            "productCondition": "string",
            "skuOriginal": "string",
            "skuName": "string",
            "gtin": "string",
            "model": "string",
            "crossdockingDays": integer,
            "supplierCode": "string",
            "erpCode": "string",
            "establishmentCode": "string",
            "moderationStatus": "string",
            "moderationDate": "string",
            "active": "string",
            "platformId": "string",
            "description": "string",
            "descriptionHTML": "string",
            "refId": "string",
            "measurementUnit": "string",
            "unitMultiplier": number
          },
          "productData": null,
          "priceData": {
            "unitPrice": number,
            "discountUnit": number,
            "netPrice": number,
            "grossPrice": number
          },
          "quantityData": {
            "quantity": integer,
            "returnedQuantity": integer
          },
          "freightData": {
            "type": "string",
            "chargedValue": number,
            "shipmentChargedValue": "string",
            "transitTime": integer,
            "commercialConditionId": "string",
            "distributionCenterId": "string",
            "freightTakeRateException": "string",
            "freightTakeRate": "string",
            "freightTakeRateSeller": "string",
            "freightTakeRateType": "string",
            "freightTakeRateMarketplace": "string",
            "freightTakeRateSellerIndex": "string",
            "freightTakeRateSubsidyPercentage": "string",
            "costType": "string",
            "weightType": "string",
            "complementLimitMarketplace": "string",
            "modalType": "string",
            "excessShippingPolicy": "string",
            "sellerParticipationShippingValue": number,
            "marketplaceParticipationShippingValue": number
          },
          "stockData": {
            "stock": "string",
            "minStock": "string",
            "move": true
          },
          "vendors": null,
          "campaigns": [],
          "operatorCampaigns": [],
          "monitoredPriceData": null
        },
      ],
    },
  ],
  "items": [
    {
      "tenant": null,
      "skuData": {
        "id": "string",
        "sku": "string",
        "productType": "string",
        "productCondition": "string",
        "skuOriginal": "string",
        "skuName": "string",
        "gtin": "string",
        "model": "string",
        "crossdockingDays": integer,
        "supplierCode": "string",
        "erpCode": "string",
        "establishmentCode": "string",
        "moderationStatus": "string",
        "moderationDate": "1970-01-01T00:00:00.000000",
        "active": true,
        "platformId": "string",
        "description": "string",
        "descriptionHTML": "string",
        "refId": "string",
        "measurementUnit": "string",
        "unitMultiplier": integer
      },
      "priceData": {
        "unitPrice": number,
        "discountUnit": number,
        "netPrice": number,
        "grossPrice": number
      },
      "quantityData": {
        "quantity": integer,
        "returnedQuantity": integer
      },
      "freightData": {
        "type": "string",
        "chargedValue": number,
        "shipmentChargedValue": integer,
        "transitTime": integer,
        "commercialConditionId": "string",
        "distributionCenterId": "string",
        "freightTakeRateException": "string",
        "freightTakeRate": "string",
        "freightTakeRateSeller": integer,
        "freightTakeRateType": "string",
        "freightTakeRateMarketplace": integer,
        "freightTakeRateSellerIndex": integer,
        "freightTakeRateSubsidyPercentage": integer,
        "costType": "string",
        "weightType": "string",
        "complementLimitMarketplace": integer,
        "modalType": "string",
        "excessShippingPolicy": "string",
        "sellerParticipationShippingValue": number,
        "marketplaceParticipationShippingValue": number
      },
      "stockData": {
        "stock": "string",
        "minStock": "string",
        "move": true
      },
      "vendors": [],
      "campaigns": [],
      "operatorCampaigns": [],
      "monitoredPriceData": null
    }
  ],
  "receivingPeriod": {
    "calculatedDeliveryTime": "string",
    "observation": "string",
    "receivingDays": []
  },
  "creditInformationData": "string",
  "campaigns": [],
  "integrators": [],
  "marketing": "string",
  "priceMonitoringData": "string",
  "commissionData": {
    "commissionPercentage": integer,
    "freightCommissionPercentage": integer,
    "commissionValue": number,
    "freightCommissionValue": number,
    "isExternalCalculation": true,
    "paidWithBonus": true
  },
  "PostageData": null
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Pedido pelo ID do Marketplace

Path Parameters

Campo	Tipo	Descrição
marketplaceId	string	(required) ID do Marketplace

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Response Parameters (2xx)

Campo	Tipo	Descrição
tenant	string	Tenant ID do Seller.
operator	string	Tenant ID do Operador (Hub).
createDate	datetime	Data de criação do Pedido.
lastUpdate	datetime	Data da última atualização.
lastEvent	string	Último evento registrado.
orderData	object	Dados do Pedido: id, status, datas de status, marketplace ID, canal de venda.
marketplaceData	object	Dados do Marketplace: ID, nome, site.
customerData	object	Dados do Comprador: nome, documento, endereço, telefones.
invoiceData	object	Dados da Nota Fiscal: chave, número, série, CFOP, links XML/DANFE.
deliveryData	object	Dados de Entrega: transportadora, rastreamento, endereço, data estimada, exceções.
shippingData	object	Dados de Envio: data de envio, etiqueta, endereço.
freightData	object	Dados do Frete: tipo, valor cobrado, transit time, modal, take rates.
orderValuesData	object	Valores do Pedido: total de itens, valor total, desconto, juros, valor líquido, valor bruto.
platformData	object	Dados da Plataforma: acrônimo, nome.
paymentData	object	Dados de Pagamento: responsável, endereço, formas de pagamento.
cancellationsData	array	Histórico de cancelamentos do Pedido.
devolutionsData	array	Histórico de devoluções: motivo, itens devolvidos, dados de logística reversa.
items	array	Itens do Pedido: SKU, preço, quantidade, frete por item, estoque.
commissionData	object	Dados de Comissionamento: percentual e valor de comissão e frete.
PostageData	object	Dados de Pré-Postagem (Correios/SIGEP).

(GET) paginado

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/
            

                
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/orders/' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json'
                
            

                
Result example 2xx:

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "sort": "string",
  "values": [
    {
      "tenant": "string",
      "operator": "string",
      "createDate": "1970-01-01T00:00:00.000000",
      "lastUpdate": "1970-01-01T00:00:00.000000",
      "lastEvent": "string",
      "orderData": {
        "id": "string",
        "status": "string",
        "orderDate": "1970-01-01T00:00:00.000000",
        "notApprovalDate": "string",
        "approvalDate": "1970-01-01T00:00:00.000000",
        "cancelDate": "string",
        "marketPlaceIdOrder": "string",
        "shippingId": "string",
        "salesChannel": "string",
        "placeOfSale": "string",
        "excludeFromSellerIndex": true
      },
      "marketplaceData": {
        "marketPlaceId": "string",
        "siteId": "string",
        "marketplace": "string",
        "lastUpdate": "1970-01-01T00:00:00.000000",
        "active": true
      },
      "customerData": {
        "name": "string",
        "exemptStateRegistration": true,
        "document": "string",
        "documentType": "string",
        "gender": "string",
        "customerType": "string",
        "email": "string",
        "emailWithMask": "string",
        "addressData": {
          "type": "string",
          "zipcode": "string",
          "address": "string",
          "number": "string",
          "complement": "string",
          "reference": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "stateAcronym": "string",
          "country": "string",
          "receiverName": "string"
        },
        "phones": [
          {
            "type": "string",
            "ddi": "string",
            "ddd": "string",
            "number": "string",
            "local": "string",
            "mobile": "string",
            "telephone": "string"
          }
        ]
      },
      "invoiceData": {
        "tenant": "string",
        "operator": "string",
        "id": "string",
        "key": "string",
        "status": "string",
        "number": "string",
        "integrationNumber": "string",
        "serie": "string",
        "cfop": "string",
        "stateRegistration": "ISENTO",
        "date": "1970-01-01T00:00:00.000000",
        "linkXML": "string",
        "base64XML": "string",
        "linkDANFE": "string",
        "base64DANFE": "string",
        "typeSEFAZ": "string",
        "messageSEFAZ": "string",
        "note": "string"
      },
      "deliveryData": {
        "type": "string",
        "deliveryChannel": "string",
        "estimatedDeliveryDate": "string",
        "deliveryDate": "1970-01-01T00:00:00.000000",
        "crossdockingDays": integer,
        "trackingCode": "string",
        "trackingURL": "string",
        "shippingMethod": "string",
        "deliveryMethodId": "string",
        "deliveryMethodName": "string",
        "quotationId": "string",
        "shippingCompany": "string",
        "documentShippingCompany": "string",
        "estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
        "sentDelayed": true,
        "addressData": {
          "type": "string",
          "zipcode": "string",
          "address": "string",
          "number": "string",
          "complement": "string",
          "reference": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "stateAcronym": "string",
          "country": "string",
          "receiverName": "string"
        },
        "deliveriesExceptions": []
      },
      "shippingData": {
        "shippingDate": "1970-01-01T00:00:00.000000",
        "estimatedShippingDate": "1970-01-01T00:00:00.000000",
        "shippingCreateDate": "string",
        "shippingExpireDate": "string",
        "shippingLabel": "string",
        "shippingLabelLink": "string",
        "shippingLabelBase64": "string",
        "shippingLabelChannelLink": "string",
        "shippingLabelChannelBase64": "string",
        "address": {
          "type": "string",
          "zipcode": "string",
          "address": "string",
          "number": "string",
          "complement": "string",
          "reference": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "stateAcronym": "string",
          "country": "string",
          "receiverName": "string"
        }
      },
      "freightData": {
        "type": "string",
        "chargedValue": number,
        "shipmentChargedValue": integer,
        "transitTime": integer,
        "commercialConditionId": "string",
        "distributionCenterId": "string",
        "freightTakeRateException": "string",
        "freightTakeRate": "string",
        "freightTakeRateSeller": integer,
        "freightTakeRateType": "string",
        "freightTakeRateMarketplace": integer,
        "freightTakeRateSellerIndex": integer,
        "freightTakeRateSubsidyPercentage": integer,
        "costType": "string",
        "weightType": "string",
        "complementLimitMarketplace": integer,
        "modalType": "string",
        "excessShippingPolicy": "string",
        "sellerParticipationShippingValue": number,
        "marketplaceParticipationShippingValue": number
      },
      "orderValuesData": {
        "items": integer,
        "value": number,
        "discount": number,
        "interest": number,
        "netValue": number,
        "grossValue": number
      },
      "platformData": {
        "acronym": "string",
        "platform": "string",
        "active": true
      },
      "paymentData": {
        "responsible": "string",
        "addressData": {
          "type": "string",
          "zipcode": "string",
          "address": "string",
          "number": "string",
          "complement": "string",
          "reference": "string",
          "neighborhood": "string",
          "city": "string",
          "state": "string",
          "stateAcronym": "string",
          "country": "string",
          "receiverName": "string"
        },
        "formsPayments": [
          {
            "marketPlaceId": "string",
            "sequence": "string",
            "type": "string",
            "value": number,
            "status": "string",
            "amountPlots": integer,
            "currencies": "string",
            "flag": "string",
            "card": "string",
            "operation": "string",
            "valid": true,
            "formPaymentId": "string",
            "paymentConditionId": "string",
            "nsu": "string",
            "paymentId": "string",
            "transactionId": "string",
            "transactionStatus": "string",
            "authorizationId": "string"
          }
        ],
        "paymentMethods": []
      },
      "cancellationsData": [],
      "devolutionsData": [
        {
          "id": "string",
          "devolutionDate": "1970-01-01T00:00:00.000000",
          "reason": "string",
          "reasonId": "string",
          "description": "string",
          "moveStock": true,
          "returnedItems": [
            {
              "tenant": null,
              "skuData": {
                "id": "string",
                "sku": "string",
                "productType": "string",
                "productCondition": "string",
                "skuOriginal": "string",
                "skuName": "string",
                "gtin": "string",
                "model": "string",
                "crossdockingDays": integer,
                "supplierCode": "string",
                "erpCode": "string",
                "establishmentCode": "string",
                "moderationStatus": "string",
                "moderationDate": "string",
                "active": "string",
                "platformId": "string",
                "description": "string",
                "descriptionHTML": "string",
                "refId": "string",
                "measurementUnit": "string",
                "unitMultiplier": number
              },
              "productData": null,
              "priceData": {
                "unitPrice": number,
                "discountUnit": number,
                "netPrice": number,
                "grossPrice": number
              },
              "quantityData": {
                "quantity": integer,
                "returnedQuantity": integer
              },
              "freightData": {
                "type": "string",
                "chargedValue": number,
                "shipmentChargedValue": "string",
                "transitTime": integer,
                "commercialConditionId": "string",
                "distributionCenterId": "string",
                "freightTakeRateException": "string",
                "freightTakeRate": "string",
                "freightTakeRateSeller": "string",
                "freightTakeRateType": "string",
                "freightTakeRateMarketplace": "string",
                "freightTakeRateSellerIndex": "string",
                "freightTakeRateSubsidyPercentage": "string",
                "costType": "string",
                "weightType": "string",
                "complementLimitMarketplace": "string",
                "modalType": "string",
                "excessShippingPolicy": "string",
                "sellerParticipationShippingValue": number,
                "marketplaceParticipationShippingValue": number
              },
              "stockData": {
                "stock": "string",
                "minStock": "string",
                "move": true
              },
              "vendors": null,
              "campaigns": [],
              "operatorCampaigns": [],
              "monitoredPriceData": null
            },
          ],
        },
      ],
      "items": [
        {
          "tenant": null,
          "skuData": {
            "id": "string",
            "sku": "string",
            "productType": "string",
            "productCondition": "string",
            "skuOriginal": "string",
            "skuName": "string",
            "gtin": "string",
            "model": "string",
            "crossdockingDays": integer,
            "supplierCode": "string",
            "erpCode": "string",
            "establishmentCode": "string",
            "moderationStatus": "string",
            "moderationDate": "1970-01-01T00:00:00.000000",
            "active": true,
            "platformId": "string",
            "description": "string",
            "descriptionHTML": "string",
            "refId": "string",
            "measurementUnit": "string",
            "unitMultiplier": integer
          },
          "priceData": {
            "unitPrice": number,
            "discountUnit": number,
            "netPrice": number,
            "grossPrice": number
          },
          "quantityData": {
            "quantity": integer,
            "returnedQuantity": integer
          },
          "freightData": {
            "type": "string",
            "chargedValue": number,
            "shipmentChargedValue": integer,
            "transitTime": integer,
            "commercialConditionId": "string",
            "distributionCenterId": "string",
            "freightTakeRateException": "string",
            "freightTakeRate": "string",
            "freightTakeRateSeller": integer,
            "freightTakeRateType": "string",
            "freightTakeRateMarketplace": integer,
            "freightTakeRateSellerIndex": integer,
            "freightTakeRateSubsidyPercentage": integer,
            "costType": "string",
            "weightType": "string",
            "complementLimitMarketplace": integer,
            "modalType": "string",
            "excessShippingPolicy": "string",
            "sellerParticipationShippingValue": number,
            "marketplaceParticipationShippingValue": number
          },
          "stockData": {
            "stock": "string",
            "minStock": "string",
            "move": true
          },
          "vendors": [],
          "campaigns": [],
          "operatorCampaigns": [],
          "monitoredPriceData": null
        }
      ],
      "receivingPeriod": {
        "calculatedDeliveryTime": "string",
        "observation": "string",
        "receivingDays": []
      },
      "creditInformationData": "string",
      "campaigns": [],
      "integrators": [],
      "marketing": "string",
      "priceMonitoringData": "string",
      "commissionData": {
        "commissionPercentage": integer,
        "freightCommissionPercentage": integer,
        "commissionValue": number,
        "freightCommissionValue": number,
        "isExternalCalculation": true,
        "paidWithBonus": true
      },
      "PostageData": null
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Consulta de Pedido paginada

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Query Parameters

Campo	Tipo	Descrição
status	string	(optional) status do Pedido
offset	integer	(optional) indica a partir de onde ocorre um aumento
limit	integer	(optional) indica a quantidade de recursos a serem devolvidos, variando de 10 a no máximo 50
sort	string	(optional) indica por qual atributo a consulta deve ser classificada (lastUpdate ou createDate) (Default lastUpdate)
last_update	string($yyyy-MM-dd'T'HH:mm:ss)	(optional) last update

Response Parameters (2xx)

Campo	Tipo	Descrição
total	integer	Total de registros encontrados.
limit	integer	Quantidade de registros retornados por página.
offset	integer	Posição inicial da página consultada.
sort	string	Campo de ordenação utilizado.
values	array	Lista de Pedidos. Cada item segue a mesma estrutura da consulta por ID (tenant, operator, orderData, customerData, items, etc.).

(PUT) /{marketplaceId}/status/canceled

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/canceled
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/canceled' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "tenant": "string",
  "moveStock": true,
  "reason": "string",
  "description": "string",
  "canceledItems": [
    {
      "skuData": {
        "sku": "string"
      },
      "quantityData": {
        "quantity": 0
      }
    }
  ]
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alteração do Status do Pedido para Cancelado. Pedidos com status DELIVERED, NOT_APPROVED, NEW, RETURNED ou EXCEPTIONDELIVERED não podem ser cancelados.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
reason	string	(required) motivo do cancelamento. Máximo 30 caracteres.
description	string	(required) descrição detalhada do motivo. Máximo 400 caracteres.
moveStock	boolean	(optional) indica se deve movimentar o estoque ao cancelar. Default: false.
canceledItems	array	(optional) lista de itens para cancelamento parcial. Se não informado, cancela o pedido inteiro. Cada item deve conter skuData.sku (string) e quantityData.quantity (integer).

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/invoiced

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/invoiced
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/invoiced' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "tenant": "string",
  "key": "string",
  "number": "string",
  "serie": "string",
  "cfop": "string",
  "stateRegistration": "string",
  "date": "1970-01-01T00:00:00.000000",
  "linkXML": "string",
  "linkDANFE": "string"
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alteração do Status do Pedido para Faturado (INVOICED). O Pedido deve estar com status APPROVED. Após faturar, o estoque é baixado automaticamente.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
date	string	(required) data de emissão da NF-e. Deve ser maior que a data de aprovação e menor que a data atual. Formato: yyyy-MM-dd'T'HH:mm:ss.
number	string	(required) número da NF-e. Apenas dígitos, máximo 9 caracteres.
serie	string	(required) série da NF-e. Apenas dígitos, máximo 3 caracteres.
key	string	(required) chave de acesso da NF-e. Apenas dígitos, exatamente 44 caracteres.
cfop	string	(required para HUB) CFOP da NF-e. Apenas dígitos, exatamente 4 caracteres.
stateRegistration	string	(optional) inscrição estadual. Aceita "ISENTA" ou "ISENTO" para estados permitidos.
linkXML	string	(optional) link para download do XML da NF-e.
linkDANFE	string	(optional) link para download do DANFE da NF-e.
marketplaceShipping	boolean	(optional) indica se o frete é responsabilidade do marketplace.

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/sent

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/sent
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/sent' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "tenant": "string",
  "date": "1970-01-01T00:00:00.000000",
  "shippingCompany": "string",
  "documentShippingCompany": "string",
  "trackingCode": "string",
  "trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
  "shippingMethod": "string",
  "shippingLabel": "string"
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alteração do Status do Pedido para Enviado (SENT). O Pedido deve estar com status INVOICED.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
date	string	(required) data de envio. Deve ser menor que a data atual. Formato: yyyy-MM-dd'T'HH:mm:ss.
trackingCode	string	(required) código de rastreamento da transportadora.
shippingCompany	string	(optional) nome da transportadora.
documentShippingCompany	string	(optional) CNPJ da transportadora.
trackingURL	string	(optional) URL de rastreamento.
shippingMethod	string	(optional) método de envio utilizado.
shippingLabel	string	(optional) etiqueta de envio.

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/delivered

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/delivered
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/delivered' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "date": "1970-01-01T00:00:00.000000"
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Alteração do Status do Pedido para Entregue (DELIVERED). O Pedido deve estar com status SENT ou EXCEPTIONDELIVERED. Não é possível confirmar entrega se houver devolução em andamento (SOLICITADA, CONFIRMADA, EM_DEVOLUCAO ou PARCIALMENTE_CONFIRMADA).

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
date	string	(required) data da entrega. Deve ser maior que a data de envio e menor que a data atual. Formato: yyyy-MM-dd'T'HH:mm:ss.

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/deliveryexception

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/deliveryexception
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/deliveryexception' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
  "date": "1970-01-01T00:00:00.000000",
  "exception": "string"
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Registro de Exceção de Entrega do Pedido. O Pedido deve estar com status SENT ou EXCEPTIONDELIVERED para utilizar este endpoint.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
date	string	(required) data da exceção de entrega. Deve ser maior que a data de envio e menor que a data atual.
exception	string	(required) descrição da exceção de entrega

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/returned/requested

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/requested
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/requested' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
    "tenant": "string",
    "reasonId": "string",
    "description": "string",
    "date": "1970-01-01T00:00:00.000000",
    "returnedItems": [
        {
            "skuData": {
                "sku": "string"
            },
            "quantityData": {
                "quantity": integer
            }
        }
    ],
    "logisticsData": {
        // Campos opcionais quando o marketplace utilizar operador envios Intelipost
        "refundType": "string", // FORMA_PAGAMENTO_ORIGINAL
        "shippingType": "string" // POSTAGEM ou COLETA
    }
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Solicitar Devolução do Pedido. O Pedido deve estar com status SENT, EXCEPTIONDELIVERED ou DELIVERED. Para pedidos DELIVERED, a data de solicitação deve ser até 90 dias após a data de entrega.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
date	string	(required) data da solicitação de devolução. Deve ser maior que a data de envio/entrega e menor que a data atual. Formato: yyyy-MM-dd'T'HH:mm:ss.
reasonId	string	(required) ID do motivo de devolução cadastrado no sistema.
description	string	(required) descrição da devolução. Máximo 250 caracteres.
returnedItems	array	(required) lista de itens a devolver. Cada item deve conter skuData.sku (string) e quantityData.quantity (integer).
logisticsData.refundType	string	(optional) tipo de restituição. Valor aceito: FORMA_PAGAMENTO_ORIGINAL.
logisticsData.shippingType	string	(optional) tipo de envio da devolução. Valores aceitos: POSTAGEM ou COLETA.

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/returned/confirmed

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/confirmed
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/confirmed' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
    "tenant": "string",
    "returnId": "string", // ADD AQUI O MARKETPLACE ID ANTES DO _R1 (R1 SE FOR A PRIMEIRA DEVOLULÇÃO, SE FOR A SEGUNDA É R2
    "date": "1970-01-01T00:00:00.000000",
    "returnedItems": [
        {
            "skuData": {
                "sku": "string"
            },
            "quantityData": {
                "quantity": integer
            }
        }
    ]
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Confirmar Devolução de Pedido solicitada. A devolução referenciada deve estar com status SOLICITADA. Se a quantidade confirmada for menor que a solicitada, a devolução ficará com status PARCIALMENTE_CONFIRMADA.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
returnId	string	(required) ID da devolução solicitada. Padrão: {marketplaceId}_R1 (R1 para primeira devolução, R2 para segunda, etc).
date	string	(required) data de confirmação da devolução. Deve ser maior que a data de solicitação. Formato: yyyy-MM-dd'T'HH:mm:ss.
returnedItems	array	(required) lista de itens confirmados para devolução. Cada item deve conter skuData.sku (string) e quantityData.quantity (integer).

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.

(PUT) /{marketplaceId}/status/returned/cancelled

    API Endpoint

        https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/cancelled
            

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned/cancelled' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
    "tenant": "string",
    "returnId": "string"
}'
                
            

                
Result example 2xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 4xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

                
Result example 5xx:

{
  "code": 0,
  "type": "string",
  "message": "string",
  "messages": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
                
            

Cancelar Devolução de Pedido solicitada. A devolução deve estar com status SOLICITADA para ser cancelada.

Path Parameters

Campo	Tipo	Descrição
marketplaceid	string	(required) Marketplace ID do Pedido

Header Parameters

Campo	Tipo	Descrição
token	string	(required) seu token de acesso
application_id	string	(required) ID do seu token de acesso
seller	string	(required) Tenant ID do Seller (se Operador)

Body Parameters

Campo	Tipo	Descrição
returnId	string	(required) ID da devolução a ser cancelada.

Response Parameters (2xx)

Campo	Tipo	Descrição
code	integer	Código de resposta.
type	string	Tipo de resposta.
message	string	Mensagem de resposta.
messages	array	Lista de mensagens adicionais de validação.
messages[].code	integer	Código da mensagem.
messages[].message	string	Texto da mensagem.