Ir para o conteúdo

API

Introdução

Bem-vindo! É através desta API que você irá integrar seu sistema ao nosso. Todas operações que podem ser feitas se encontram abaixo.

Nossa API é RESTful e todas as respostas são em JSON.

Endpoint

Todas as requisições são feitas no endpoint https://app.dropify.com.br/api

Autenticação

Screenshot

Utilizamos o protocolo OAuth2 para autorização na API.

Obter o token de acesso

Faça uma chamada POST em https://app.dropify.com.br/oauth usando as credenciais de integração da sua loja. No corpo de requisição, defina grant_type para client_credentials. Quando você executa o comando, aDropify gera e retorna um novo token de acesso (access token).

Após recebê-lo, para autenticar-se é necessário enviar o seguinte cabeçalho HTTP nas próximas requisições, substituindo <access-token> pelo retornado na requisição:

Authorization: Bearer <access-token>

POST https://app.dropify.com.br/oauth

Parâmetros

Nome Descrição Detalhes
grant_type Tipo de autenticação (client_credentials) string, required
client_id Identificador do cliente (encontrado no painel da loja) string, required
client_secret Senha (encontrado no painel da loja) string, required
{
  "access_token": "<access-token>",
  "expires_in": 3600,
  "token_type": "Bearer",
  "scope": null
}

Produtos

Listar todos os produtos

Retorna todos os produtos oferecidos por algum fornecedor em nosso catálogo, estejam eles disponíveis atualmente ou não.

Info

Um produto pode ou não ter variações, que são combinações diferentes de atributos para um mesmo item. Nesse caso, você deve utilizar o SKU das variações ao invés do item principal. Exemplos: voltagens 127v e 220v.

GET /products

Parâmetros

Nome Descrição Detalhes
page Página dos produtos a serem retornados number
per_page Quantidade de produtos por página a serem retornados (máx: 60) number
updated_since Lista produtos que foram alterados desde a data informada Y-m-d H:i:s
brand Filtra os produtos pelo nome de uma marca string
{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/products?page=1"
    },
    "first": {
      "href": "https://app.dropify.com.br/api/products"
    },
    "last": {
      "href": "https://app.dropify.com.br/api/products?page=1328"
    },
    "next": {
      "href": "https://app.dropify.com.br/api/products?page=2"
    }
  },
  "_embedded": {
    "product": [
      {
        "sku": "DY3540",
        "name": "Capacete Urban Tamanho M Azul Bi061 - Atrio",
        "slug": "capacete-urban-tamanho-m-azul-bi061-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806815",
        "ncm": "00000000",
        "images": [],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-azul-bi061-atrio1.png"
          }
        },
        "attachments": [],
        "description": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "shortDescription": "Capacete Urban Tamanho M Azul Bi061 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete",
        "measurements": {
          "weight": 276,
          "height": 12,
          "length": 27,
          "width": 2
        },
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3540"
          }
        }
      },
      {
        "sku": "DY3539",
        "name": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "slug": "capacete-urban-tamanho-m-brancoazul-bi059-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806792",
        "ncm": "00000000",
        "images": [
          {
            "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png"
            }
          }
        ],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png"
          }
        },
        "attachments": [],
        "description": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "shortDescription": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi059\r\n- Referência: Capacete Urban\r\n- Cor (Es): Branco/Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete Urban Tamanho M Branco/Azul Bi059",
        "measurements": {
          "weight": 270,
          "height": 2,
          "length": 28,
          "width": 15
        },
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3539"
          }
        }
      }
    ]
  },
  "page_count": 1328,
  "page_size": 2,
  "total_items": 2655,
  "page": 1
}
{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/products?page=1"
    },
    "first": {
      "href": "https://app.dropify.com.br/api/products"
    },
    "last": {
      "href": "https://app.dropify.com.br/api/products?page=1328"
    },
    "next": {
      "href": "https://app.dropify.com.br/api/products?page=2"
    }
  },
  "_embedded": {
    "product": [
      {
        "sku": "DY3540",
        "name": "Capacete Urban Tamanho M Bi061 - Atrio",
        "slug": "capacete-urban-tamanho-m-bi061-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806815",
        "ncm": "00000000",
        "images": [],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-bi061-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-bi061-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-bi061-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-bi061-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-bi061-atrio1.png"
          }
        },
        "attachments": [],
        "description": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "shortDescription": "Capacete Urban Tamanho M Bi061 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete",
        "measurements": {
          "weight": 276,
          "height": 12,
          "length": 27,
          "width": 2
        },
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3540"
          }
        }
      },
      {
        "sku": "DY3539",
        "name": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "slug": "capacete-urban-tamanho-m-brancoazul-bi059-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806792",
        "ncm": "00000000",
        "images": [
          {
            "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png"
            }
          }
        ],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png"
          }
        },
        "attachments": [],
        "description": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "shortDescription": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi059\r\n- Referência: Capacete Urban\r\n- Cor (Es): Branco/Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete Urban Tamanho M Branco/Azul Bi059",
        "measurements": {
          "weight": 270,
          "height": 2,
          "length": 28,
          "width": 15
        },
        "variations": [
            {
                "sku": "DY3540-01",
                "attributes": [
                    {
                        "name": "Cor",
                        "code": "COLOR",
                        "option": "Azul"
                    }
                ]
            },
            {
                "sku": "DY3540-02",
                "attributes": [
                    {
                        "name": "Cor",
                        "code": "COLOR",
                        "option": "Vermelho"
                    }
                ]
            }
        ],
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3539"
          }
        }
      }
    ]
  },
  "page_count": 1328,
  "page_size": 2,
  "total_items": 2655,
  "page": 1
}

Listar todos os produtos disponíveis

Retorna todos os produtos disponíveis para compra em nosso catálogo.

GET /products/available

Parâmetros

Nome Descrição Detalhes
page Página dos produtos a serem retornados number
per_page Quantidade de produtos por página a serem retornados (máx: 60) number
updated_since Lista produtos que foram alterados desde a data informada Y-m-d H:i:s
brand Filtra os produtos pelo nome de uma marca string
{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/products/available?page=1"
    },
    "first": {
      "href": "https://app.dropify.com.br/api/products/available"
    },
    "last": {
      "href": "https://app.dropify.com.br/api/products/available?page=685"
    },
    "next": {
      "href": "https://app.dropify.com.br/api/products/available?page=2"
    }
  },
  "_embedded": {
    "product": [
      {
        "sku": "DY3540",
        "name": "Capacete Urban Tamanho M Azul Bi061 - Atrio",
        "slug": "capacete-urban-tamanho-m-azul-bi061-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806815",
        "ncm": "00000000",
        "images": [],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-azul-bi061-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-azul-bi061-atrio1.png"
          }
        },
        "attachments": [],
        "description": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "shortDescription": "Capacete Urban Tamanho M Azul Bi061 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi061\r\n- Referência: Capacete Urban\r\n- Cor (Es): Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete",
        "measurements": {
          "weight": 276,
          "height": 12,
          "length": 27,
          "width": 2
        },
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3540"
          }
        }
      },
      {
        "sku": "DY3539",
        "name": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "slug": "capacete-urban-tamanho-m-brancoazul-bi059-atrio",
        "categories": [
          {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes"
          }
        ],
        "brand": "Atrio",
        "warranty": 90,
        "available": true,
        "gtin": "7899838806792",
        "ncm": "00000000",
        "images": [
          {
            "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png",
              "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio2.png"
            }
          }
        ],
        "mainImage": {
          "filename": "https://cdn.com/og/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "medium": "https://cdn.com/md/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "large": "https://cdn.com/lg/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png",
            "extralarge": "https://cdn.com/xl/capacete-urban-tamanho-m-brancoazul-bi059-atrio1.png"
          }
        },
        "attachments": [],
        "description": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "shortDescription": "Capacete Urban Tamanho M Branco/Azul Bi059 - Atrio",
        "technicalDescription": "- Esporte: Proteção Individual\r\n- Marca: Atrio/Multilaser\r\n- Modelo: Bi059\r\n- Referência: Capacete Urban\r\n- Cor (Es): Branco/Azul\r\n- Gênero: Unissex\r\n- Garantia Do Fabricante: 03 Meses Contra Defeitos De Fabricação",
        "includedItems": "- 01 Capacete Urban Tamanho M Branco/Azul Bi059",
        "measurements": {
          "weight": 270,
          "height": 2,
          "length": 28,
          "width": 15
        },
        "_embedded": {
          "category": {
            "id": "57684886aaaec43423598086",
            "name": "Capacetes",
            "slug": "capacetes",
            "parents": [
              {
                "id": "55ad24154c7a6fdb5013ab00",
                "name": "Para Bicicleta",
                "slug": "para-bicicleta"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57684886aaaec43423598086"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3539"
          }
        }
      }
    ]
  },
  "page_count": 685,
  "page_size": 2,
  "total_items": 1369,
  "page": 1
}

Info

ATENÇÃO: Para buscar as informações de preço e estoque dos produtos, você deve consultar o endpoint Buscar preço e estoque dos produtos disponíveis. Se seu usuário for de integrador, você deve utilizar um token de lojista para retornar as informações corretas.

Buscar preço e estoque dos produtos disponíveis

Retorna apenas informações de preço e estoque dos produtos disponíveis.

Info

Um produto pode ou não ter variações, que são combinações diferentes de atributos para um mesmo item. Nesse caso, você deve utilizar o SKU das variações ao invés do item principal. Exemplos: voltagens 127v e 220v.

GET /products/available/price-inventory-general

Parâmetros

Nome Descrição Detalhes
page Página dos produtos a serem retornados. number
per_page Quantidade de produtos por página a serem retornados (máx: 500) number
updated_since Lista produtos que foram alterados desde a data informada. Y-m-d H:i:s
brand Filtra os produtos pelo nome de uma marca. string
sku Filtra por um SKU. string
{
    "_links": {
        "self": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general?page=1"
        },
        "first": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general"
        },
        "last": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general?page=1"
        }
    },
    "_embedded": {
        "product": [
            {
                "sku": "DY10999",
                "immediateShipment": false,
                "stockQuantity": 101,
                "suggestedRetailPrice": {
                    "amount": 9600,
                    "currency": "BRL"
                },
                "salePrice": {
                    "amount": 4567,
                    "currency": "BRL"
                },
                "profitMargin": {
                    "amount": 5033,
                    "currency": "BRL"
                }
            },
            {
                "sku": "DY10998",
                "immediateShipment": true,
                "stockQuantity": 100,
                "suggestedRetailPrice": {
                    "amount": 1500,
                    "currency": "BRL"
                },
                "salePrice": {
                    "amount": 1059,
                    "currency": "BRL"
                },
                "profitMargin": {
                    "amount": 441,
                    "currency": "BRL"
                }
            }
        ]
    },
    "page_count": 1,
    "page_size": 2,
    "total_items": 2,
    "page": 1
}
{
    "_links": {
        "self": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general?page=1"
        },
        "first": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general"
        },
        "last": {
            "href": "https://app.dropify.com.br/api/products/available/price-inventory-general?page=1"
        }
    },
    "_embedded": {
        "product": [
            {
                "sku": "DY10999",
                "immediateShipment": false,
                "variations": [
                    {
                        "sku": "DY10999-01",
                        "attributes": [
                            {
                                "name": "Tamanho",
                                "code": "SIZE",
                                "option": "Pequeno"
                            }
                        ],
                        "suggestedRetailPrice": {
                            "amount": 2000,
                            "currency": "BRL"
                        },
                        "salePrice": {
                            "amount": 1871,
                            "currency": "BRL"
                        },
                        "profitMargin": {
                            "amount": 129,
                            "currency": "BRL"
                        },
                        "stockQuantity": 96
                    },
                    {
                        "sku": "DY10999-02",
                        "attributes": [
                            {
                                "name": "Tamanho",
                                "code": "SIZE",
                                "option": "Grande"
                            }
                        ],
                        "suggestedRetailPrice": {
                            "amount": 2500,
                            "currency": "BRL"
                        },
                        "salePrice": {
                            "amount": 1677,
                            "currency": "BRL"
                        },
                        "profitMargin": {
                            "amount": 823,
                            "currency": "BRL"
                        },
                        "stockQuantity": 11
                    }
                ]
            },
            {
                "sku": "DY10998",
                "immediateShipment": true,
                "stockQuantity": 100,
                "suggestedRetailPrice": {
                    "amount": 1500,
                    "currency": "BRL"
                },
                "salePrice": {
                    "amount": 1059,
                    "currency": "BRL"
                },
                "profitMargin": {
                    "amount": 441,
                    "currency": "BRL"
                }
            }
        ]
    },
    "page_count": 1,
    "page_size": 2,
    "total_items": 2,
    "page": 1
}

Listar todos os produtos indisponíveis

Todos os produtos que estão atualmente indisponíveis, fora de estoque ou desativados.

GET /products/unavailable

Parâmetros

Nome Descrição Detalhes
page Página dos produtos a serem retornados. number
per_page Quantidade de produtos por página a serem retornados (máx: 60) number
updated_since Lista produtos que foram alterados desde a data informada. Y-m-d H:i:s
brand Filtra os produtos pelo nome de uma marca. string
{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/products/unavailable?page=1"
    },
    "first": {
      "href": "https://app.dropify.com.br/api/products/unavailable"
    },
    "last": {
      "href": "https://app.dropify.com.br/api/products/unavailable?page=643"
    },
    "next": {
      "href": "https://app.dropify.com.br/api/products/unavailable?page=2"
    }
  },
  "_embedded": {
    "product": [
      {
        "sku": "DY3439",
        "name": "Super Massa Dinossauros Estrela",
        "slug": "super-massa-dinossauros-estrela",
        "categories": [
          {
            "id": "575091c0aaaec420e57f5ce8",
            "name": "Brinquedos 04 Anos em Diante",
            "slug": "brinquedos-04-anos-em-diante"
          },
          {
            "id": "575091f2aaaec44edc7f5d02",
            "name": "Brinquedos 04 Anos em Diante",
            "slug": "brinquedos-04-anos-em-Diante"
          }
        ],
        "brand": "Estrela",
        "warranty": 90,
        "available": false,
        "gtin": "7896027545180",
        "ncm": "00000000",
        "images": [
          {
            "filename": "https://cdn.com/og/super-massa-dinossauros-estrela2.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/super-massa-dinossauros-estrela2.png",
              "medium": "https://cdn.com/md/super-massa-dinossauros-estrela2.png",
              "large": "https://cdn.com/lg/super-massa-dinossauros-estrela2.png",
              "extralarge": "https://cdn.com/xl/super-massa-dinossauros-estrela2.png"
            }
          }
        ],
        "mainImage": {
          "filename": "https://cdn.com/og/super-massa-dinossauros-estrela1.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/super-massa-dinossauros-estrela1.png",
            "medium": "https://cdn.com/md/super-massa-dinossauros-estrela1.png",
            "large": "https://cdn.com/lg/super-massa-dinossauros-estrela1.png",
            "extralarge": "https://cdn.com/xl/super-massa-dinossauros-estrela1.png"
          }
        },
        "attachments": [],
        "description": "A fabriquinha Super Massa da Estrela é a oportunidade ideal para os seus filhos começarem a criar formas e descobrir novas cores. São formas divertidas e moldes diferentes para a criança criar as mais variadas brincadeiras. A Super Massa Dinossauros vem vários moldes de dinossauros para a criança criar os animais mais aterrorizantes! Também acompanham moldes para criar árvores e brincar junto ao cenário. Um momento de muita diversão que irá desenvolver a coordenação motora, a criatividade, a imaginação, a percepção das cores, espessuras e muito mais. Um brinquedo que une diversão e aprendizagem!",
        "shortDescription": "Super Massa Dinossauros Estrela",
        "technicalDescription": "- Marca: Estrela\r\n- Tipo de Brincadeira: Massa de modelar\r\n- Idade recomendada: 3 a 4 anos\r\n- Gênero: Unissex\r\n- Composição/Material: Plástico\r\n- Número de Participantes: 1 ou mais\r\n- Como Brincar: Utilizar a massa de modelar para moldar árvores e dinossauros preferidos",
        "includedItems": "- 5 moldes de dinossauros\r\n- 1 molde do tronco de árvore\r\n- 1 molde para topo da árvore\r\n- 1 faca\r\n- 1 cenário A3\r\n- 3 potes Super Massa com 50g cada",
        "measurements": {
          "weight": 470,
          "height": 20,
          "length": 30,
          "width": 5
        },
        "_embedded": {
          "category": {
            "id": "575091c0aaaec420e57f5ce8",
            "name": "Brinquedos 04 Anos em Diante",
            "slug": "brinquedos-04-anos-em-diante",
            "parents": [
              {
                "id": "55a402ce7bec50e1413c809d",
                "name": "Brinquedos Meninos",
                "slug": "brinquedos-meninos"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "http://app.dropify.com.br/api/categories/575091c0aaaec420e57f5ce8"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "http://app.dropify.com.br/api/products/DY3439"
          }
        }
      },
      {
        "sku": "DY3341",
        "name": "Travesseiro Látex Lavável Sintético Eucaliptus p/fronhas 50x70",
        "slug": "travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x70",
        "categories": [
          {
            "id": "57053f1d263a7b6f441adce1",
            "name": "Travesseiros",
            "slug": "travesseiros"
          }
        ],
        "brand": "Fibrasca",
        "warranty": 90,
        "available": false,
        "gtin": "7896630342169",
        "ncm": "94049000",
        "images": [
          {
            "filename": "https://cdn.com/og/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x702.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x702.png",
              "medium": "https://cdn.com/md/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x702.png",
              "large": "https://cdn.com/lg/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x702.png",
              "extralarge": "https://cdn.com/xl/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x702.png"
            }
          },
          {
            "filename": "https://cdn.com/og/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x703.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x703.png",
              "medium": "https://cdn.com/md/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x703.png",
              "large": "https://cdn.com/lg/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x703.png",
              "extralarge": "https://cdn.com/xl/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x703.png"
            }
          },
          {
            "filename": "https://cdn.com/og/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x704.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x704.png",
              "medium": "https://cdn.com/md/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x704.png",
              "large": "https://cdn.com/lg/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x704.png",
              "extralarge": "https://cdn.com/xl/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x704.png"
            }
          },
          {
            "filename": "https://cdn.com/og/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x705.png",
            "title": null,
            "types": {
              "small": "https://cdn.com/sm/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x705.png",
              "medium": "https://cdn.com/md/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x705.png",
              "large": "https://cdn.com/lg/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x705.png",
              "extralarge": "https://cdn.com/xl/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x705.png"
            }
          }
        ],
        "mainImage": {
          "filename": "https://cdn.com/og/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x701.png",
          "title": null,
          "types": {
            "small": "https://cdn.com/sm/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x701.png",
            "medium": "https://cdn.com/md/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x701.png",
            "large": "https://cdn.com/lg/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x701.png",
            "extralarge": "https://cdn.com/xl/travesseiro-latex-lavavel-sintetico-eucaliptus-pfronhas-50x701.png"
          }
        },
        "attachments": [],
        "description": "Para um bom descanso, seja em casa ou durante uma viagem, o ideal é que se possa usufruir de travesseiros confortáveis, higiênicos e com altura que seja especifica para a cada necessidade pessoal e fisiológica.\r\nO Travesseiro Fibrasca Látex Sintético Eucaliptus, foi confeccionado com uma exclusiva tecnologia de moléculas abertas tornam possível a passagem da água por dentro da espuma de látex sintético, proporcionando mais praticidade ao lavar.\r\nPossui ainda orifícios de circulação do ar, que melhoram o frescor do produto, ajudando para prevenção de proliferação de ácaros, fungos e bactérias, visto que, seu revestimento em malha de algodão possui leve aroma de eucalipto em seu enchimento, proporcionando o melhor bem-estar ao deitar.",
        "shortDescription": "Travesseiro Látex Lavável Sintético Eucaliptus p/fronhas 50x70",
        "technicalDescription": "**Características Gerais**\r\n- Moderno e sofisticado \r\n- Deixará sua residência harmoniosa e delicada \r\n- Produzido através de matérias primas de boa qualidade \r\n- Resistente e seguro \r\n- Nº de Fios: Não Possui\r\n- Formato: Convencional\r\n- Composição do revestimento: 100% Viscose\r\n- Composição do enchimento: 100% Poliuretano\r\n- Tecido: Malha\r\n- Antialérgico: sim\r\n- Antiácaro: sim\r\n- Antibactéria: sim\r\n- Antifungo: sim\r\n- Íons de Prata: não\r\n- Anatômico: não\r\n- Ortopédico: não\r\n- Lavável: sim\r\n- Indicado p/: dormir de lado,de barriga p/ cima,de bruços\r\n- Medidas: 50 x 70 cm\r\n- Cor: Branco\r\n\r\n**Cuidados com o Produto **\r\n- Produto integralmente lavável em máquina; \r\n- Não lavar acima de 40ºC; \r\n- Não alvejar, não branquear; \r\n- Secar de preferência na posição horizontal.",
        "includedItems": "- 1 Travesseiro Fibrasca Látex Sintético Eucaliptus com Fibras Naturais em Malha 50 x 70 cm 1 Peça - Branco",
        "measurements": {
          "weight": 600,
          "height": 58,
          "length": 12,
          "width": 37
        },
        "_embedded": {
          "category": {
            "id": "57053f1d263a7b6f441adce1",
            "name": "Travesseiros",
            "slug": "travesseiros",
            "parents": [
              {
                "id": "56bb5f99263a7b466d00f432",
                "name": "Casa e Decoração",
                "slug": "casa-decoracao"
              }
            ],
            "children": [],
            "_links": {
              "self": {
                "href": "https://app.dropify.com.br/api/categories/57053f1d263a7b6f441adce1"
              }
            }
          }
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/products/DY3341"
          }
        }
      }
    ]
  },
  "page_count": 643,
  "page_size": 2,
  "total_items": 1286,
  "page": 1
}

Info

ATENÇÃO: Para buscar as informações de preço e estoque dos produtos, você deve consultar o endpoint Buscar preço e estoque dos produtos disponíveis. Se seu usuário for de integrador, você deve utilizar um token de lojista para retornar as informações corretas.

Buscar um produto

Retorna um produto.

GET /products/[SKU]

Parâmetros

Nome Descrição Detalhes
sku SKU do produto. alphanumeric, required
{
  "sku": "DY3439",
  "name": "Super Massa Dinossauros Estrela",
  "slug": "super-massa-dinossauros-estrela",
  "categories": [
    {
      "id": "575091c0aaaec420e57f5ce8",
      "name": "Brinquedos 04 Anos em Diante",
      "slug": "brinquedos-04-anos-em-diante"
    },
    {
      "id": "575091f2aaaec44edc7f5d02",
      "name": "Brinquedos 04 Anos em Diante",
      "slug": "brinquedos-04-anos-em-Diante"
    }
  ],
  "brand": "Estrela",
  "warranty": 90,
  "available": false,
  "gtin": "7896027545180",
  "ncm": "00000000",
  "images": [
    {
      "filename": "https://cdn.com/og/super-massa-dinossauros-estrela2.png",
      "title": null,
      "types": {
        "small": "https://cdn.com/sm/super-massa-dinossauros-estrela2.png",
        "medium": "https://cdn.com/md/super-massa-dinossauros-estrela2.png",
        "large": "https://cdn.com/lg/super-massa-dinossauros-estrela2.png",
        "extralarge": "https://cdn.com/xl/super-massa-dinossauros-estrela2.png"
      }
    }
  ],
  "mainImage": {
    "filename": "https://cdn.com/og/super-massa-dinossauros-estrela1.png",
    "title": null,
    "types": {
      "small": "https://cdn.com/sm/super-massa-dinossauros-estrela1.png",
      "medium": "https://cdn.com/md/super-massa-dinossauros-estrela1.png",
      "large": "https://cdn.com/lg/super-massa-dinossauros-estrela1.png",
      "extralarge": "https://cdn.com/xl/super-massa-dinossauros-estrela1.png"
    }
  },
  "attachments": [],
  "description": "A fabriquinha Super Massa da Estrela é a oportunidade ideal para os seus filhos começarem a criar formas e descobrir novas cores. São formas divertidas e moldes diferentes para a criança criar as mais variadas brincadeiras. A Super Massa Dinossauros vem vários moldes de dinossauros para a criança criar os animais mais aterrorizantes! Também acompanham moldes para criar árvores e brincar junto ao cenário. Um momento de muita diversão que irá desenvolver a coordenação motora, a criatividade, a imaginação, a percepção das cores, espessuras e muito mais. Um brinquedo que une diversão e aprendizagem!",
  "shortDescription": "Super Massa Dinossauros Estrela",
  "technicalDescription": "- Marca: Estrela\r\n- Tipo de Brincadeira: Massa de modelar\r\n- Idade recomendada: 3 a 4 anos\r\n- Gênero: Unissex\r\n- Composição/Material: Plástico\r\n- Número de Participantes: 1 ou mais\r\n- Como Brincar: Utilizar a massa de modelar para moldar árvores e dinossauros preferidos",
  "includedItems": "- 5 moldes de dinossauros\r\n- 1 molde do tronco de árvore\r\n- 1 molde para topo da árvore\r\n- 1 faca\r\n- 1 cenário A3\r\n- 3 potes Super Massa com 50g cada",
  "measurements": {
    "weight": 470,
    "height": 20,
    "length": 30,
    "width": 5
  },
  "_embedded": {
    "category": {
      "id": "575091c0aaaec420e57f5ce8",
      "name": "Brinquedos 04 Anos em Diante",
      "slug": "brinquedos-04-anos-em-diante",
      "parents": [
        {
          "id": "55a402ce7bec50e1413c809d",
          "name": "Brinquedos Meninos",
          "slug": "brinquedos-meninos"
        }
      ],
      "children": [],
      "_links": {
        "self": {
          "href": "https://app.dropify.com.br/api/categories/575091c0aaaec420e57f5ce8"
        }
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/products/DY3439"
    }
  }
}

Estoques

Listar estoques

Lista o estoque de todos os produtos.

GET /stocks

Parâmetros

Nome Descrição Detalhes
page Página dos estoques a serem retornados. number
per_page Quantidade de produtos por página a serem retornados (máx: 1000) number
{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/stocks?page=1"
    },
    "first": {
      "href": "https://app.dropify.com.br/api/stocks"
    },
    "last": {
      "href": "https://app.dropify.com.br/api/stocks?page=531"
    },
    "next": {
      "href": "https://app.dropify.com.br/api/stocks?page=2"
    }
  },
  "_embedded": {
    "stock": [
      {
        "sku": "DY11",
        "stockQuantity": "0"
      },
      {
        "sku": "DY13",
        "stockQuantity": "0"
      },
      {
        "sku": "DY14",
        "stockQuantity": "0"
      },
      {
        "sku": "DY15",
        "stockQuantity": "0"
      },
      {
        "sku": "DY16",
        "stockQuantity": "0"
      }
    ]
  },
  "page_count": 531,
  "page_size": 5,
  "total_items": 2655,
  "page": 1
}

Pedidos

Cadastrar pedidos

Neste endpoint é possível cadastrar um pedido no sistema da Dropify. Você deve informar os dados do consumidor, lista de itens, as informações de entrega e opcionalmente o ID externo do pedido.

POST /orders

Info

Um produto pode ou não ter variações, que são combinações diferentes de atributos para um mesmo item.
Nesse caso, você deve utilizar o SKU das variações ao invés do item principal.
Exemplos: voltagens 127v e 220v.

{
  "onHold": "false",
  "externalOrderId": "MEUID",
  "salesChannel": "LOJA_FISICA",
  "consumer": {
    "consumerType": "naturalPerson",
    "name": "João Silva",
    "email": "[email protected]",
    "phoneNumber": "(11) 1234-1234",
    "mobilePhoneNumber": "(11) 1234-1234",
    "cpfCnpj": "28672352009",
    "taxpayerSituation": 3,
    "address": {
      "postalCode": "12345-678",
      "street": "R. Principal",
      "number": 109,
      "district": "Jardim das Palmeiras"
    }
  },
  "items": [
    {
      "sku": "DY1869",
      "quantity": 1,
      "salePrice": 5000
    }
  ],
  "shippingMethod": "CUSTOM_LABEL",
  "customLabelUrl": "https://minha_url_etiqueta.com",
  "trackingCode": "SW485376878BR"
}

Status do pedido

Status (PT) Status (EN) Descrição
Em espera On hold Pedido em espera a pedido do lojista
Em solicitação On request Um pedido do produto foi feito para a fábrica *
Em trânsito In transit O pedido feito para fabrica está a caminho daDropify *
Em emissão Fiscal Labeling Aguardando a emissão da nota fiscal
Em separação Picking Separação e preparação do pedido
Em expedição On dispatch Expedição do pedido
Remetido Submitted Pedido enviado para o cliente final
Entregue Sent Pedido entregue
Cancelado Canceled Pedido cancelado
Disponível para retirada Available for withdrawal Pedido com retirada local disponível para o cliente retirar
Aguardando item Awaiting item Troca solicitada, aguardando produto do cliente
Aguardando troca Awaiting exchange Produto a ser trocado chegou naDropify, processando troca
Entregue para transportadora Delivered to carrier Produto entregue para a transportadora

Info

* Somente pedidos de remessa normal (que não são remessa imediata) passam por esses status

Dados variáveis

Campo Descrição Valores possíveis
consumerType Tipo do consumidor naturalPerson ou legalPerson
taxpayerSituation Situação do contribuinte 1 para Contribuinte ICMS
2 para Contribuinte isento
3 para Não contribuinte

Métodos de envio

Valores possíveis do campo shippingMethod:

Nome Código
PAC PAC
PAC + AR PAC_AR
SEDEX SEDEX
SEDEX + AR SEDEX_AR
Jadlog Econômico JADLOG_ECONOMIC
Jadlog .com JADLOG_DOTCOM
Minha Etiqueta CUSTOM_LABEL
Retirada Local LOCAL_WITHDRAW

Canais de venda

O campo salesChannel é obrigatório e indica onde foi realizada a venda. Para isso, informe o Código do canal informado na tabela abaixo:

Canal Código
001 Shop 001_SHOP
00K e-business Tools 00K_EBUSINESS_TOOLS
Adena ADENA
Amazon AMAZON
Americanas AMERICANAS
Bis2Bis BIS2BIS
BizCommerce BIZCOMMERCE
Carrefour CARREFOUR
Casas Bahia CASAS_BAHIA
Centauro CENTAURO
CiaShop CIASHOP
Cissa Marketplace CISSA_MARKETPLACE
CW Store CW_STORE
Dafiti DAFITI
DlojaVirtual DLOJAVIRTUAL
DotStore DOTSTORE
E-com.club E_COM_CLUB
E-completo E_COMPLETO
Elo7 ELO7
Extra EXTRA
EZCommerce EZCOMMERCE
Fast Commerce FAST_COMMERCE
FastCommerce FASTCOMMERCE
FBITS E-commerce One Stop Shop FBITS_ECOMMERCE
Fbits FBITS
Groupon GROUPON
Hibrido HIBRIDO
Infracommerce INFRACOMMERCE
Interspire INTERSPIRE
Irroba IRROBA
iSET ISET
JET JET
JN2 JN2
Kanui KANUI
Leroy Merlin LEROY_MERLIN
LikeStore LIKESTORE
Locaweb LOCAWEB
Loja física LOJA_FISICA
Loja Integrada LOJA_INTEGRADA
LojaMestre LOJAMESTRE
Lojas Colombo LOJAS_COLOMBO
Lojas Virtuais BR LOJAS_VIRTUAIS_BR
Madeira Madeira MADEIRA_MADEIRA
Magazine Luiza MAGAZINE_LUIZA
Magento MAGENTO
MaxiStore MAXISTORE
Mercado Livre MERCADO_LIVRE
Mercado Shops MERCADO_SHOPS
MeusPedidos MEUSPEDIDOS
Mformula MFORMULA
MineStore MINESTORE
MkX MKX
Moovin MOOVIN
Netshoes NETSHOES
Nuvem Shop NUVEM_SHOP
OpenCart OPENCART
Outra plataforma OUTRA_PLATAFORMA
Peixe Urbano PEIXE_URBANO
Perasloja PERASLOJA
Ponto Frio PONTO_FRIO
PrestaShop PRESTASHOP
Ricardo Eletro RICARDO_ELETRO
ShopDelivery SHOPDELIVERY
Shopee SHOPEE
Shopify SHOPIFY
Shoptime SHOPTIME
Signativa SIGNATIVA
Simplo7 SIMPLO7
SisEcommerce SISECOMMERCE
Submarino SUBMARINO
Tray TRAY
Tricae TRICAE
Vtex VTEX
WapStore WAPSTORE
Wbuy WBUY
WDNA WDNA
Web Continental WEB_CONTINENTAL
WebJump WEBJUMP
WebStore WEBSTORE
WideCommerce WIDECOMMERCE
Wix WIX
Woo Commerce WOO_COMMERCE
Z3Web Z3WEB
Zattini ZATTINI

Info

Essa lista pode sofrer alterações a qualquer momento. Se possuir alguma sugestão, entre em contato conosco através do https://dropify.com.br/fale-conosco.

Pedidos em espera

É possível colocar um novo pedido em espera por até 7 dias. Se depois de 7 dias o pedido não tiver autorização do lojista para entrar no fluxo para expedição, o sistema irá cancelar automaticamente e devolver o saldo.

Para colocar um pedido em espera você deve definir o campo onHold como true.

Dica

Veja como autorizar um pedido em espera em Autorizar pedidos
Também é possível trocar a etiqueta de um pedido em espera em Trocar etiqueta

{
  "id": "2587",
  "date": "28/03/2016 10:53:48",
  "status": "Submitted",
  "subtotal": {
    "amount": 11668,
    "currency": "BRL"
  },
  "total": {
    "amount": 11868,
    "currency": "BRL"
  },
  "shipment": {
    "id": "CUSTOM_LABEL",
    "name": "Custom label",
    "trackingCode": null,
    "price": {
      "amount": 0,
      "currency": "BRL"
    }
  },
  "store": {
    "name": "Minha loja",
    "platform": "Megafashion",
    "url": "",
    "phoneNumber": "12312312312",
    "mobilePhoneNumber": "12922222222",
    "address": {
      "country": "Brasil",
      "state": "SP",
      "postalCode": "12345678",
      "city": "São Paulo",
      "district": "Jardim das Palmeiras",
      "street": "Rua Principal",
      "number": "115",
      "complement": ""
    }
  },
  "consumer": {
    "cpf": "28672352009",
    "name": "João Silva",
    "email": "[email protected]",
    "phone": "(11) 1234-1234",
    "mobilePhone": "(11) 1234-1234",
    "address": {
      "country": "Brasil",
      "state": "SP",
      "postalCode": "12345-678",
      "city": "São Paulo",
      "district": "Jardim das Palmeiras",
      "street": "R. Principal",
      "number": "109",
      "complement": ""
    }
  },
  "items": [
    {
      "product": "Polidor Automotivo - Au605",
      "sku": "DY1869",
      "quantity": 1,
      "price": {
        "amount": 11668,
        "currency": "BRL"
      },
      "salePrice": {
        "amount": 5000,
        "currency": "BRL"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/orders/2587"
    }
  }
}

Autorizar pedido em espera

Autoriza um pedido em espera.

PATCH /orders/[order_id]

Parâmetros

Nome Descrição Detalhes
order_id Identificador do pedido number, required
{
  "onHold": "false"
}

Trocar etiqueta de um pedido em espera

Troca a etiqueta de um pedido em espera.

PATCH /orders/[order_id]

Parâmetros

Nome Descrição Detalhes
order_id Identificador do pedido number, required
{
  "customLabelUrl": "https://minha_nova_etiqueta.com",
  "trackingCode": "SW4853788232878BR"
}

Buscar um pedido

Retorna um pedido.

GET /orders/[order_id]

Parâmetros

Nome Descrição Detalhes
order_id Identificador do pedido number, required
{
  "id": "42",
  "externalOrderId": "MEUID",
  "date": "02/09/2015 15:34:46",
  "status": "Submitted",
  "subtotal": {
    "amount": 43131,
    "currency": "BRL"
  },
  "total": {
    "amount": 44961,
    "currency": "BRL"
  },
  "shipment": {
    "id": "SEDEX",
    "name": "Sedex",
    "trackingCode": null,
    "price": {
      "amount": 1830,
      "currency": "BRL"
    }
  },
  "store": {
    "name": "Bob's store",
    "platform": "Magento",
    "url": "teste",
    "phoneNumber": "(47) 9645-1342",
    "mobilePhoneNumber": "(47) 9645-1341",
    "address": {
      "country": "Brasil",
      "state": "SC",
      "postalCode": "89027-450",
      "city": "Blumenau",
      "district": "Progresso",
      "street": "Rua Olga Hadlich",
      "number": "133",
      "complement": ""
    }
  },
  "consumer": {
    "cpf": "28672352009",
    "name": "James Woodson",
    "email": "[email protected]",
    "phone": "5539309999",
    "mobilePhone": "55888888888",
    "address": {
      "country": "Brasil",
      "state": "SP",
      "postalCode": "01311300",
      "city": "São Paulo",
      "district": "Bela Vista",
      "street": "Avenida Paulista",
      "number": "100",
      "complement": ""
    }
  },
  "items": [
    {
      "product": "Capa Clear View Galaxy S6 Edge Dourada ",
      "sku": "DY1864",
      "quantity": 3,
      "price": {
        "amount": 14377,
        "currency": "BRL"
      },
      "salePrice": {
        "amount": 15600,
        "currency": "BRL"
      }
    }
  ],
  "_links": {
    "self": {
      "href": "http://app.dropify.com.br/api/orders/42"
    }
  }
}

Buscar notas fiscais

Retorna nota fiscal de compra e nota fiscal de remessa de um pedido.

GET /tax-invoices/[order_id]

Parâmetros

Nome Descrição Detalhes
order_id Identificador do pedido number, required
{
    "TaxInvoice": {
        "danfe": "https://example.com",
        "xml": "https://example.com"
    },
    "ShippingTaxInvoice": {
        "danfe": "https://example.com",
                "xml": "https://example.com"
    },
    "_links": {
        "self": {
            "href": "https://app.dropify.com.br/api/tax-invoices/0000"
        }
    }
}

Calcular frete

Você deve informar o código postal e uma lista de itens para receber as formas de entrega disponíveis.

POST /shipments

{
  "postalCode": "03110300",
  "items": [
    {
      "sku": "DY1234",
      "quantity": 5,
      "price": {
        "amount": 500,
        "currency": "BRL"
      }
    },
    {
      "sku": "DY1348",
      "quantity": 2,
      "price": {
        "amount": 550,
        "currency": "BRL"
      }
    }
  ]
}
{
  "0": {
    "id": "SEDEX",
    "name": "Sedex",
    "price": 2248,
    "currency": "BRL"
  },
  "1": {
    "id": "PAC",
    "name": "PAC",
    "price": 1514,
    "currency": "BRL"
  },
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/shipments"
    }
  }
}

Loja

Neste endpoint, retornaremos o dados da sua loja.

GET /stores

{
  "_links": {
    "self": {
      "href": "https://app.dropify.com.br/api/stores"
    }
  },
  "_embedded": {
    "store": [
      {
        "id": "4270808f-d1d3-4314-a7e4-6c6b590c7a26",
        "name": "Teste - MG",
        "type": "CompanyStore",
        "status": "Approved",
        "platform": "Outra plataforma",
        "url": "",
        "address": {
          "street": "Rua oito",
          "number": "100",
          "complement": "",
          "district": "Centro",
          "city": "Campestre",
          "state": "MG",
          "country": "Brasil",
          "postalCode": "37730970"
        },
        "contact": {
          "phoneNumber": "0000000",
          "mobilePhoneNumber": "0000000"
        },
        "taxData": {
          "responsibleName": "João",
          "cnpj": "74809940000162",
          "taxpayerSituation": 1,
          "ie": "123.123.123/1234"
        },
        "webhook": {
          "isActive": true,
          "payloadUrl": "http://minha-url.com",
          "events": [
            "stock",
            "immediate-shipment",
            "availability-status"
          ]
        },
        "_links": {
          "self": {
            "href": "https://app.dropify.com.br/api/stores/4270808f-d1d3-4314-a7e4-6c6b590c7a26"
          }
        }
      }
    ]
  },
  "total_items": 1
}

Webhook

Neste endpoint é possível cadastrar, atualizar e verificar a propriedade da URL que receberá as atualizações de eventos.

PATCH /stores/[store_id]

Cadastrar ou atualizar

{
    "webhook": {
      "isActive": true,
      "payloadUrl": "http://minha-url.com",
      "events": [
          "stock",
          "immediate-shipment",
          "availability-status"
      ]
    }
}

Eventos disponíveis

Nome Código
Estoque stock
Preço price
Remessa imediata immediate-shipment
Status de disponibilidade availability-status
Status do produto product-status
Status do pedido order-status

Atenção: Sempre que você alterar a URL, vamos enviar uma requisição POST com um código de verificação para a URL. A verificação informa aDropify que você é um proprietário autorizado da URL informada. Veja abaixo como verificar sua URL.

PATCH /stores/[store_id]

Verificar a propriedade da URL, utilize o código de verificação recebido via POST. Veja um exemplo de código de verificação recebido via POST.

{
    "webhook": {
      "verificationCode": "4688163e-258f-43b0-9c18-2b009afd376e"
    }
}