API docs by Redocly

MIMP - APIs de integração e-commerce com ERP CISS (1.0)

Download OpenAPI specification:Download

API for integrarion with CISSLive, CISSBox e CISSPoder

MimpApiV1

Mimp API V1

order receiver

order

header Parameters
Authorization
required
any

Token for API access control.

Accept
required
any

application/json

Content Type
required
any

application/json

Accept-Language
any
Example: en-US pt-BR

Locale to translate messages.

Request Body schema: application/json
required
object
orderId
required
string [ 1 .. 50 ] characters

Your order id

displayId
string [ 1 .. 50 ] characters

Order display number

sellerId
string [ 1 .. 200 ] characters

Your seller id

orderDate
required
string <date-time>

Date and time that order was created

scheduledDate
string <date-time>

Expected delivery date and time

deliveryType
required
string
Enum: "PICKUP" "DELIVERY"

Delivery type:

  • PICKUP - Pickup the order in store
  • DELIVERY - Delivery the order
deliveryOwner
string
Enum: "DELIVERY_BY_STORE" "DELIVERY_BY_ECOMMERCE"

Delivery owner:

  • DELIVERY_BY_STORE - Order delivered by the store
  • DELIVERY_BY_ECOMMERCE - Order delivered by the e-commerce
shippingCompanyId
string <= 50 characters

Company code that will ship the goods

orderPickupCode
string <= 10 characters

Code to confirm the shipping

required
object (CustomerRequest)
taxPayerIdentificationNumberOnInvoice
boolean
Default: true

Put the taxPayer Identification on invoice

object (AddressRequest)
required
Array of objects (ItemRequest) [ 1 .. 500 ] items

Sold items

orderTotalValue
required
decimal

Total amount of the order. (items.totalPrice + shippingAmount + orderTotalAddition - orderTotalDiscount)

shippingAmount
decimal
Default: 0

Delivery Fee Amount

orderTotalAddition
decimal
Default: 0

Total additional value of the order

orderTotalDiscount
decimal
Default: 0

Total discount value of the order

instructions
string [ 0 .. 200 ] characters

Instructions for this order

authorizedPickupPerson
string [ 0 .. 50 ] characters

Authorized person to pick up the order. It should be used when the person that will receive the goods is different from the person that made the order.

required
Array of objects (PaymentRequest) [ 1 .. 10 ] items

Payments

object
invoiceType
string
Enum: "RECEIPT" "INVOICE"

Invoice Type:

  • RECEIPT
  • INVOICE
Array of objects
object

Responses

Request samples

Content type
application/json
{
  • "store": {
    },
  • "orderId": "AN28554",
  • "displayId": "AN28554-CHRISTMAS-ORDER",
  • "sellerId": "SELLER5134",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "deliveryType": "DELIVERY",
  • "deliveryOwner": "DELIVERY_BY_STORE",
  • "shippingCompanyId": "string",
  • "orderPickupCode": "string",
  • "customer": {
    },
  • "taxPayerIdentificationNumberOnInvoice": true,
  • "shippingAddress": {
    },
  • "items": [
    ],
  • "orderTotalValue": 47.3,
  • "shippingAmount": 5,
  • "orderTotalAddition": 5.37,
  • "orderTotalDiscount": 10.89,
  • "instructions": "Favor colocar em uma caixa",
  • "authorizedPickupPerson": "João da Silva",
  • "payments": [
    ],
  • "ecommerceIdentification": {
    },
  • "invoiceType": "RECEIPT",
  • "options": [
    ],
  • "configurations": {
    }
}

Response samples

Content type
application/json
{
  • "internalId": "80CCC72A-50A7-4608-AAC4-49DF4E5AD3E3",
  • "createAt": "2019-08-24T14:15:22Z"
}

order cancel

Event to cancel the order. This event may cancel the order if it has not yet been completed or it may request the creation of a new return order.

path Parameters
internalId
required
string

Internal order id

header Parameters
Authorization
required
any

Token for API access control.

Accept
required
any

application/json

Content Type
required
any

application/json

Accept-Language
any
Example: en-US pt-BR

Locale to translate messages.

Request Body schema: application/json
orderId
required
string [ 1 .. 50 ] characters

Your order id

eventDate
required
string <date-time>

Date and time that event was created

observation
string [ 0 .. 200 ] characters

Observation for this order event

Responses

Request samples

Content type
application/json
{
  • "orderId": "AN28554",
  • "eventDate": "2019-08-24T14:15:22Z",
  • "observation": ""
}

Response samples

Content type
application/json
{
  • "store": {
    },
  • "orderId": "string",
  • "displayId": "string",
  • "orderTotalValue": 53,
  • "sequentialNumber": 256,
  • "orderStatus": {
    },
  • "internalId": "36C9CB59-CD1A-41D5-9754-EFF23020D764",
  • "orderDate": "2022-09-09T12:05:00",
  • "detailedStatus": "Pedido Faturado",
  • "invoice": {
    }
}

Order resume

Get Order Status and Invoice by internal id

path Parameters
internalId
required
string

Internal order id

header Parameters
Authorization
required
any

Token for API access control.

Accept
required
any

application/json

Content Type
required
any

application/json

Accept-Language
any
Example: en-US pt-BR

Locale to translate messages.

Responses

Response samples

Content type
application/json
{
  • "store": {
    },
  • "orderId": "string",
  • "displayId": "string",
  • "orderTotalValue": 53,
  • "sequentialNumber": 256,
  • "orderStatus": {
    },
  • "internalId": "36C9CB59-CD1A-41D5-9754-EFF23020D764",
  • "orderDate": "2022-09-09T12:05:00",
  • "detailedStatus": "Pedido Faturado",
  • "invoice": {
    }
}

order resume by period

Order resume by period.

query Parameters
dhFim
required
string
Example: dhFim=2015-11-01T20:00:00

Start date

dhInicio
required
string
Example: dhInicio=2015-10-01T20:00:00

Start date

header Parameters
Authorization
required
any

Token for API access control.

Accept
required
any

application/json

Content Type
required
any

application/json

Accept-Language
any
Example: en-US pt-BR

Locale to translate messages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Order resume by period v2

Order resume by period v2

query Parameters
dhFim
required
string
Example: dhFim=2015-11-01T20:00:00

Start date

dhInicio
required
string
Example: dhInicio=2015-10-01T20:00:00

Start date

nrPedido
string
Examples:
  • nrPedido=P-213253321 - Value with starting non numeric value
  • nrPedido=213253321-O - Value with ending non numeric value
  • nrPedido=213253321 - Value only numeric value
  • nrPedido=kpfm-21z31db-f123/159213 - Hash or uuid, Important, must be url encoded, this example will be translated to kpfm-21z31db-f123%2F159213

Order number

header Parameters
Authorization
required
any

Token for API access control.

Accept
required
any

application/json

Content Type
required
any

application/json

Accept-Language
any
Example: en-US pt-BR

Locale to translate messages.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Order

required
object
orderId
required
string [ 1 .. 50 ] characters

Your order id

displayId
string [ 1 .. 50 ] characters

Order display number

sellerId
string [ 1 .. 200 ] characters

Your seller id

orderDate
required
string <date-time>

Date and time that order was created

scheduledDate
string <date-time>

Expected delivery date and time

deliveryType
required
string
Enum: "PICKUP" "DELIVERY"

Delivery type:

  • PICKUP - Pickup the order in store
  • DELIVERY - Delivery the order
deliveryOwner
string
Enum: "DELIVERY_BY_STORE" "DELIVERY_BY_ECOMMERCE"

Delivery owner:

  • DELIVERY_BY_STORE - Order delivered by the store
  • DELIVERY_BY_ECOMMERCE - Order delivered by the e-commerce
shippingCompanyId
string <= 50 characters

Company code that will ship the goods

orderPickupCode
string <= 10 characters

Code to confirm the shipping

required
object (CustomerRequest)
taxPayerIdentificationNumberOnInvoice
boolean
Default: true

Put the taxPayer Identification on invoice

object (AddressRequest)
required
Array of objects (ItemRequest) [ 1 .. 500 ] items

Sold items

orderTotalValue
required
decimal

Total amount of the order. (items.totalPrice + shippingAmount + orderTotalAddition - orderTotalDiscount)

shippingAmount
decimal
Default: 0

Delivery Fee Amount

orderTotalAddition
decimal
Default: 0

Total additional value of the order

orderTotalDiscount
decimal
Default: 0

Total discount value of the order

instructions
string [ 0 .. 200 ] characters

Instructions for this order

authorizedPickupPerson
string [ 0 .. 50 ] characters

Authorized person to pick up the order. It should be used when the person that will receive the goods is different from the person that made the order.

required
Array of objects (PaymentRequest) [ 1 .. 10 ] items

Payments

object
invoiceType
string
Enum: "RECEIPT" "INVOICE"

Invoice Type:

  • RECEIPT
  • INVOICE
Array of objects
object
{
  • "store": {
    },
  • "orderId": "AN28554",
  • "displayId": "AN28554-CHRISTMAS-ORDER",
  • "sellerId": "SELLER5134",
  • "orderDate": "2019-08-24T14:15:22Z",
  • "scheduledDate": "2019-08-24T14:15:22Z",
  • "deliveryType": "DELIVERY",
  • "deliveryOwner": "DELIVERY_BY_STORE",
  • "shippingCompanyId": "string",
  • "orderPickupCode": "string",
  • "customer": {
    },
  • "taxPayerIdentificationNumberOnInvoice": true,
  • "shippingAddress": {
    },
  • "items": [
    ],
  • "orderTotalValue": 47.3,
  • "shippingAmount": 5,
  • "orderTotalAddition": 5.37,
  • "orderTotalDiscount": 10.89,
  • "instructions": "Favor colocar em uma caixa",
  • "authorizedPickupPerson": "João da Silva",
  • "payments": [
    ],
  • "ecommerceIdentification": {
    },
  • "invoiceType": "RECEIPT",
  • "options": [
    ],
  • "configurations": {
    }
}

Customer

customerId
string [ 0 .. 50 ] characters

Customer identification

name
required
string [ 2 .. 100 ] characters

Customer name

taxPayerIdentificationNumber
string

CPF or CNPJ (This field is required when order.taxPayerIdentificationNumberOnInvoice is true)

email
string [ 3 .. 50 ] characters

Customer name

phoneNumber
string [ 9 .. 14 ] characters

Phone number (when integrating with Loggi, it is mandatory)

inscriptionNumber
string

Inscription Number (State registration number)

object (AddressRequest)
{
  • "customerId": "352",
  • "name": "João da Silva",
  • "taxPayerIdentificationNumber": "05416515645",
  • "email": "joaodasilva@mail.com",
  • "phoneNumber": "5511988776655",
  • "inscriptionNumber": "123456789",
  • "address": {
    }
}

Address

street
required
string [ 2 .. 100 ] characters

Street name

number
required
string [ 1 .. 20 ] characters

Number

district
required
string [ 2 .. 60 ] characters

District

city
required
string [ 2 .. 60 ] characters

City name

state
required
string = 2 characters

State code

zipcode
required
string = 8 characters

Zip Code - CEP in Brazil

ibgeCode
string = 7 characters

IBGE code, this code is needed in Brazil

adjunct
string [ 0 .. 50 ] characters

Adjunct

landmark
string [ 0 .. 50 ] characters

landmark (reference point)

latitude
string [ 0 .. 50 ] characters

latitude

longitude
string [ 0 .. 50 ] characters

longitude

{
  • "street": "Av. Rio Grande do Sul",
  • "number": "1284",
  • "district": "Centro",
  • "city": "Dois Vizinhos",
  • "state": "PR",
  • "zipcode": "85660000",
  • "ibgeCode": "4107207",
  • "adjunct": "Casa dos fundos",
  • "landmark": "Ao lado do Posto de combustível",
  • "latitude": "-25.742291",
  • "longitude": "-53.0533737"
}

Item

productId
required
string [ 1 .. 60 ] characters

Product unique id - SKU

description
string [ 0 .. 200 ] characters

Product description

ean
string [ 0 .. 14 ] characters

Product EAN (European Article Number)

quantity
required
decimal

Quantity of items sold

price
required
decimal

Unit price, price per item

totalPrice
required
decimal

Total price. ((quantity * price) - discount + addition) or (quantity * price) for item.type equal to "KIT"

discount
decimal
Default: 0

Total discount value

addition
decimal
Default: 0

Total additional value

observation
string [ 0 .. 1000 ] characters

Observation of item

imageURL
string <= 1000 characters

Product image URL for customization

object (GiftCardRequest)

Gift Card information

type
string
Default: "PRODUCT"
Enum: "PRODUCT" "KIT"

Item type:

  • PRODUCT - Item is a product
  • KIT - Item is a kit, contains other items
Array of objects [ 1 .. 500 ] items

Items contained in the kit (This field is required when item.type is "KIT")

{
  • "productId": "A0000154",
  • "description": "Pão Frances",
  • "ean": 7890154612152,
  • "quantity": 10,
  • "price": 4.55,
  • "totalPrice": 42.3,
  • "discount": 5.5,
  • "addition": 2.3,
  • "observation": "Sem açucar",
  • "imageURL": "http://cdn.imagens.com.br/product.png",
  • "giftCard": {
    },
  • "type": "KIT",
  • "itemsKit": [
    ]
}

OrderResume

object (Store)
orderId
string

Order id

displayId
string

Order display number

orderTotalValue
float
sequentialNumber
int
object (OrderStatus)
internalId
string

Order internal id

orderDate
string

Order Date

detailedStatus
string

Order Detailed status

object (Invoice)
{
  • "store": {
    },
  • "orderId": "string",
  • "displayId": "string",
  • "orderTotalValue": 53,
  • "sequentialNumber": 256,
  • "orderStatus": {
    },
  • "internalId": "36C9CB59-CD1A-41D5-9754-EFF23020D764",
  • "orderDate": "2022-09-09T12:05:00",
  • "detailedStatus": "Pedido Faturado",
  • "invoice": {
    }
}