(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 |
(POST) /status/new
API Endpoint
https://api.omnik.io/HUB/v1/orders/status/new
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/orders/status/new' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"deliveryMethodId": "string",
"deliveryMethodName": "string",
"quotationId": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
]
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "string"
}
}'
Result example 2xx:
{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000",
"id": "string",
"status": "string"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"type": "string",
"deliveryChannel": "string",
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
],
"estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
"sentDelayed": true
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "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"
}
]
}
Consulta de Assuntos
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/notapproved
API Endpoint
https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/notapproved
# Here is a curl example
curl --location \
https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/notapproved \
--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",
"moveStock": true
}'
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"
}
]
}
Consulta de Pedido pelo Marketplace ID do Pedido
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 |
| moveStock |
boolean |
(optional) movimenta estoque? |
(PUT) /{marketplaceId}/status/approved
API Endpoint
https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/approved
# Here is a curl example
curl --location \
https://api.omnik.io/HUB/v1/orders/marketplaceid/{marketplaceId}/status/approved \
--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"
}
]
}
Consulta de Pedido pelo Marketplace ID do Pedido
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 |
(POST) /status/notapproved
API Endpoint
https://api.omnik.io/HUB/v1/orders/status/notapproved
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/orders/status/notapproved' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000",
"notApprovalDate": "1970-01-01T00:00:00.000000"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"type": "string",
"deliveryChannel": "string",
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
],
"estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
"sentDelayed": true
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "string"
}
}'
Result example 2xx:
{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000",
"notApprovalDate": "1970-01-01T00:00:00.000000",
"id": "string",
"status": "string"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"type": "string",
"deliveryChannel": "string",
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
],
"estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
"sentDelayed": true
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "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"
}
]
}
Consulta de Assuntos
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) |
(POST) /status/approved
API Endpoint
https://api.omnik.io/HUB/v1/orders/status/approved
# Here is a curl example
curl --location 'https://api.omnik.io/HUB/v1/orders/status/approved' \
--header 'token: {token}' \
--header 'application_id: {application_id}' \
--header 'seller: {seller-tenant}' \
--header 'Content-Type: application/json' \
--data '{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000",
"approvalDate": "1970-01-01T00:00:00.000000"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"type": "string",
"deliveryChannel": "string",
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
],
"estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
"sentDelayed": true
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "string"
}
}'
Result example 2xx:
{
"createDate": "1970-01-01T00:00:00.000000",
"lastUpdate": "1970-01-01T00:00:00.000000",
"tenant": "string",
"account": "string",
"orderData": {
"orderDate": "1970-01-01T00:00:00.000000",
"approvalDate": "1970-01-01T00:00:00.000000",
"id": "string",
"status": "string"
},
"marketplaceData": {
"marketPlaceId": "string",
"siteId": "string",
"marketplace": "string",
"lastUpdate": "1970-01-01T00:00:00.000000"
},
"customerData": {
"name": "string",
"document": "string",
"documentType": "string",
"gender": "string",
"customerType": "string",
"email": "string",
"corporateName": "string",
"tradeName": "string",
"corporateDocument": "string",
"corporatePhone": "string",
"stateInscription": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"phones": [
{
"type": "string",
"ddi": "string",
"ddd": "string",
"number": "string",
"local": "string"
}
]
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"deliveryData": {
"type": "string",
"deliveryChannel": "string",
"deliveryDate": "1970-01-01T00:00:00.000000",
"estimatedDeliveryDate": "1970-01-01T00:00:00.000000",
"crossdockingDays": 0,
"shippingCompany": "string",
"documentShippingCompany": "string",
"trackingCode": "string",
"trackingURL": "https://www.xpto.com.br/123/sl12344.pdf",
"shippingMethod": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"deliveriesExceptions": [
{
"deliveryExceptionDate": "1970-01-01T00:00:00.000000",
"exception": "string",
"user": {
"code": "string",
"name": "string",
"email": "string",
"login": "string",
"hubSessionId": "string"
}
}
],
"estimatedDeliveryDateCalculated": "1970-01-01T00:00:00.000000",
"sentDelayed": true
},
"paymentData": {
"responsible": "string",
"addressData": {
"type": "string",
"zipcode": "string",
"address": "string",
"number": "string",
"complement": "string",
"neighborhood": "string",
"city": "string",
"state": "string",
"stateAcronym": "string",
"country": "string"
},
"formsPayments": [
{
"paymentId": "string",
"sequence": "string",
"type": "string",
"value": 0,
"status": "string",
"amountPlots": 0,
"currencies": "string",
"card": "string",
"operation": "string",
"valid": true,
"formPaymentId": "string",
"paymentConditionId": "string"
}
]
},
"orderValuesData": {
"items": 0,
"value": 0,
"discount": 0,
"interest": 0,
"netValue": 0,
"grossValue": 0
},
"items": [
{
"skuData": {
"id": "string",
"sku": "string",
"skuName": "string",
"supplierCode": "string",
"erpCode": "string",
"establishmentCode": "string"
},
"priceData": {
"unitPrice": 0,
"grossPrice": 0,
"discountUnit": 0,
"netPrice": 0
},
"quantityData": {
"quantity": 0
},
"freightData": {
"type": "string",
"chargedValue": 0,
"transitTime": 0
},
"stockData": {
"move": true
},
"campaigns": [
{
"id": "string",
"campaignType": "string"
}
]
}
],
"campaigns": {
"id": "string",
"campaignType": "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"
}
]
}
Consulta de Assuntos
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) |
