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": [],
  "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)

(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": [],
      "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

(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

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)

(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

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)

(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

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)

(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

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)

Bodu Parameters

Campo	Tipo	Descrição
date	string	(required) data da não aprovação do Pedido

(PUT) /{marketplaceId}/status/returned

    API Endpoint

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

                
# Here is a curl example
curl --location --request \
PUT 'https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/returned' \
--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",
  "moveStock": true,
  "reason": "string",
  "description": "string",
  "returnedItems": [
    {
      "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 Devolvido

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)