Zé Seller Public API

https://seller-public-api.ze.delivery/docs
Admin
Zé Seller Public API is a comprehensive REST API for merchants to manage orders, products,...
Tokens:16,669
Snippets:72
Trust Score:8.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Restore Edited Order (JSON Response Example)

Source: https://seller-public-api.ze.delivery/docs

Provides an example of a JSON response when attempting to restore an edited order. This operation is only permitted for orders with a 'CONFIRMED' status.

```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```

--------------------------------

### POST /logistics/startRoute/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Informs that the delivery person has picked up the order and started the delivery route. Requires the order number and the delivery person's email.

```APIDOC
## POST /logistics/startRoute/{orderNumber}

### Description
Informs that the delivery person has picked up the order and started the delivery route. Requires the order number and the delivery person's email.

### Method
POST

### Endpoint
/logistics/startRoute/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The order number on the Ze Delivery platform (minimum 9 characters).

#### Query Parameters
None

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **email** (string) - Required - The email of the delivery person.

### Request Example
```json
{
  "email": "string"
}
```

### Response
#### Success Response (202)
- **message** (string) - Indicates that the request is being processed.

#### Response Example (202)
```json
{ }
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### Get Delivery Details Response Sample (JSON)

Source: https://seller-public-api.ze.delivery/docs

This is a sample JSON response when successfully retrieving delivery details. It includes order display ID, customer name, delivery man information, merchant details, and delivery price.

```json
{
  "orderDisplayId": "123457890",
  "customerName": "Maria",
  "deliveryMan": {
    "email": "Maria@ze.delivery"
  },
  "merchant": {
    "id": "Maria@ze.delivery"
  },
  "deliveryPrice": {
    "price": {
      "value": 10,
      "currency": "BRL"
    }
  }
}
```

--------------------------------

### GET /merchants/{merchantId}/kpis

Source: https://seller-public-api.ze.delivery/docs

Retrieves operational KPIs for a merchant based on granularity and date.

```APIDOC
## GET /merchants/{merchantId}/kpis

### Description
Allows integrators to consult operational KPIs for a seller to be used in dashboards and performance monitoring.

### Method
GET

### Endpoint
/merchants/{merchantId}/kpis

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the establishment.

#### Query Parameters
- **granularity** (string) - Required - Enum: "HOUR", "DAY", "WEEK", "MONTH".
- **referenceDate** (string) - Required - Date in YYYY-MM-DD format.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token.

### Response
#### Success Response (200)
- **data** (object) - Returns consolidated indicators structured by group.
```

--------------------------------

### Retrieve merchant menu items response schema

Source: https://seller-public-api.ze.delivery/docs

JSON structure for the GET response when fetching merchant menu items. Includes pagination metadata and a list of product objects with pricing and category details.

```json
{
  "currentPage": 0,
  "totalPages": 0,
  "totalItems": 0,
  "pageSize": 0,
  "items": [
    {
      "productId": 0,
      "externalProductId": "string",
      "name": "string",
      "description": "string",
      "status": "AVAILABLE",
      "image": {
        "URL": "string"
      },
      "ean": "string",
      "isFavorite": true,
      "brand": {
        "id": "string",
        "name": "string"
      },
      "categories": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "priceDetails": {
        "price": 0,
        "discount": {
          "endsAt": "string",
          "id": "string",
          "startsAt": "string",
          "values": [
            {
              "value": 0,
              "finalUnitPrice": 0,
              "minQuantity": 0,
              "maxQuantity": 0,
              "valueType": "FIXED_AMOUNT"
            }
          ]
        },
        "sellerDiscount": {
          "active": true,
          "percentageValues": [0],
          "current": {
            "createdAt": "string",
            "discountPercentageValue": 0,
            "id": "string",
            "active": true,
            "reason": "string",
            "updatedAt": "string",
            "username": "string"
          }
        },
        "takeRateSeller": {
          "active": true,
          "feeAmount": 0,
          "feePercentage": 0,
          "netPrice": 0
        }
      }
    }
  ]
}
```

--------------------------------

### GET /merchants/kpis

Source: https://seller-public-api.ze.delivery/docs

Retrieves performance KPIs for a merchant, including order metrics, fill rates, and delivery accuracy.

```APIDOC
## GET /merchants/kpis

### Description
Retrieves general and turbo delivery performance KPIs for a merchant.

### Method
GET

### Endpoint
/merchants/kpis

### Response
#### Success Response (200)
- **kpis** (object) - Contains general and turbo performance metrics.
- **updatedDate** (string) - Timestamp of the last update.

#### Response Example
{
  "kpis": {
    "general": {
      "validOrders": {"type": "INTEGER", "value": "26"},
      "fillRate": {"type": "PERCENTAGE", "value": "92.86"}
    },
    "turbo": {
      "validTurboOrders": {"type": "INTEGER", "value": "4"}
    },
    "updatedDate": "2026-03-06T18:54:53.887Z"
  }
}
```

--------------------------------

### GET /orders/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Retrieves detailed information about a specific order using its platform order number.

```APIDOC
## GET /orders/{orderNumber}

### Description
Retrieves the details of a specific order by its order number. Note: Sensitive customer information availability depends on legal agreements.

### Method
GET

### Endpoint
/orders/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The unique identifier of the order (min length 9).

#### Header Parameters
- **Authorization** (string) - Required - Bearer token for authentication.

### Response
#### Success Response (200)
- **order** (object) - The order details object.

#### Error Handling
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
```

--------------------------------

### GET /merchants/{merchantId}/menu/items

Source: https://seller-public-api.ze.delivery/docs

Retrieves a list of menu items for a specific merchant. This endpoint allows sellers to view their products available on Zé Delivery, with options for pagination and filtering by external product IDs.

```APIDOC
## GET /merchants/{merchantId}/menu/items

### Description
Retrieves a list of menu items for a specific merchant. This endpoint allows sellers to view their products available on Zé Delivery, with options for pagination and filtering by external product IDs.

### Method
GET

### Endpoint
`/merchants/{merchantId}/menu/items`

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the merchant.

#### Query Parameters
- **page** (number) - Optional - The page number. Defaults to 1.
- **pageSize** (number) - Optional - The number of items per page. Defaults to 5. (Range: 5 to 30)
- **externalProductIds** (string) - Optional - Comma-separated external IDs of the items. If not provided, all items are returned.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

### Response
#### Success Response (200)
- **currentPage** (integer) - The current page number.
- **totalPages** (integer) - The total number of pages.
- **totalItems** (integer) - The total number of items.
- **pageSize** (integer) - The number of items per page.
- **items** (array) - An array of product items.
  - **productId** (integer) - The identifier of the product on the Zé Delivery platform.
  - **externalProductId** (string) - The identifier of the product on a third-party platform.
  - **name** (string) - The name of the product.
  - **description** (string) - The description of the product.
  - **status** (string) - The availability status of the product (e.g., "AVAILABLE").
  - **image** (object) - Information about the product image.
    - **URL** (string) - The URL of the product image.
  - **ean** (string) - The EAN (barcode) of the product.
  - **isFavorite** (boolean) - Indicates if the product is a favorite.
  - **brand** (object) - Information about the product brand.
    - **id** (string) - The ID of the brand.
    - **name** (string) - The name of the brand.
  - **categories** (array) - An array of product categories.
    - **id** (string) - The ID of the category.
    - **name** (string) - The name of the category.
  - **priceDetails** (object) - Detailed pricing information.
    - **price** (number) - The current price of the product.
    - **discount** (object) - Information about active discounts.
      - **endsAt** (string) - The end date/time of the discount.
      - **id** (string) - The ID of the discount.
      - **startsAt** (string) - The start date/time of the discount.
      - **values** (array) - Details of the discount values.
        - **value** (number) - The discount value.
        - **finalUnitPrice** (number) - The final unit price after discount.
        - **minQuantity** (integer) - The minimum quantity for the discount.
        - **maxQuantity** (integer) - The maximum quantity for the discount.
        - **valueType** (string) - The type of discount value (e.g., "FIXED_AMOUNT").
    - **sellerDiscount** (object) - Information about seller-specific discounts.
      - **active** (boolean) - Indicates if the seller discount is active.
      - **percentageValues** (array) - Array of discount percentage values.
      - **current** (object) - Details of the current seller discount.
        - **createdAt** (string) - The creation date/time of the discount.
        - **discountPercentageValue** (number) - The percentage value of the discount.
        - **id** (string) - The ID of the discount.
        - **active** (boolean) - Indicates if the discount is active.
        - **reason** (string) - The reason for the discount.
        - **updatedAt** (string) - The last update date/time of the discount.
        - **username** (string) - The username associated with the discount.
    - **takeRateSeller** (object) - Information about the seller's take rate.
      - **active** (boolean) - Indicates if the take rate is active.
      - **feeAmount** (number) - The fee amount.
      - **feePercentage** (number) - The fee percentage.
      - **netPrice** (number) - The net price.

#### Response Example (Success)
```json
{
  "currentPage": 0,
  "totalPages": 0,
  "totalItems": 0,
  "pageSize": 0,
  "items": [
    {
      "productId": 0,
      "externalProductId": "string",
      "name": "string",
      "description": "string",
      "status": "AVAILABLE",
      "image": {
        "URL": "string"
      },
      "ean": "string",
      "isFavorite": true,
      "brand": {
        "id": "string",
        "name": "string"
      },
      "categories": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "priceDetails": {
        "price": 0,
        "discount": {
          "endsAt": "string",
          "id": "string",
          "startsAt": "string",
          "values": [
            {
              "value": 0,
              "finalUnitPrice": 0,
              "minQuantity": 0,
              "maxQuantity": 0,
              "valueType": "FIXED_AMOUNT"
            }
          ]
        },
        "sellerDiscount": {
          "active": true,
          "percentageValues": [
            0
          ],
          "current": {
            "createdAt": "string",
            "discountPercentageValue": 0,
            "id": "string",
            "active": true,
            "reason": "string",
            "updatedAt": "string",
            "username": "string"
          }
        },
        "takeRateSeller": {
          "active": true,
          "feeAmount": 0,
          "feePercentage": 0,
          "netPrice": 0
        }
      }
    }
  ]
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### GET /merchants/{merchantId}

Source: https://seller-public-api.ze.delivery/docs

Retrieves detailed information about a specific merchant.

```APIDOC
## GET /merchants/{merchantId}

### Description
Retrieves the details and current status of a merchant.

### Method
GET

### Endpoint
/merchants/{merchantId}

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the establishment.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token.

### Response
#### Success Response (200)
- **status** (string) - Current availability status.
- **basicInfo** (object) - Merchant portfolio information.

#### Response Example
{
  "status": "AVAILABLE",
  "basicInfo": {
    "idealPortfolio": {
      "totalProducts": 0,
      "totalActiveProducts": 0,
      "activeProductsPercentage": 0
    }
  }
}
```

--------------------------------

### Get Delivery Details (Path Parameters)

Source: https://seller-public-api.ze.delivery/docs

This section describes the parameters required to retrieve delivery details for a specific order. The 'orderNumber' is a mandatory path parameter that uniquely identifies the order.

```json
{
  "orderNumber": "123456789"
}
```

--------------------------------

### Poll Order Events via GET request

Source: https://seller-public-api.ze.delivery/docs

Retrieves a list of order events for specific merchants. Supports filtering by event type and requires an authorization token and merchant IDs in the header.

```json
[
  {
    "eventId": "3e7224ac-bec0-4fe1-88d1-6348c8149c44",
    "orderId": 123456789,
    "orderURL": "https://seller-public-api.ze.delivery/orders/123456789",
    "eventType": "CREATED",
    "sourceAppId": "",
    "createdAt": "2021-09-15T19:51:57.851343"
  }
]
```

--------------------------------

### GET /logistics/delivery/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Retrieves the delivery details for a specific order using its order number on the Ze Delivery platform. Requires an authorization token.

```APIDOC
## GET /logistics/delivery/{orderNumber}

### Description
Retrieves the delivery details for a specific order using its order number on the Ze Delivery platform. Requires an authorization token.

### Method
GET

### Endpoint
/logistics/delivery/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The order number on the Ze Delivery platform (minimum 9 characters).

#### Query Parameters
None

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

### Request Example
None

### Response
#### Success Response (200)
- **orderDisplayId** (string) - The display ID of the order.
- **customerName** (string) - The name of the customer.
- **deliveryMan** (object) - Details about the delivery person.
  - **email** (string) - The email of the delivery person.
- **merchant** (object) - Details about the merchant.
  - **id** (string) - The ID of the merchant.
- **deliveryPrice** (object) - Details about the delivery price.
  - **price** (object) - The price details.
    - **value** (number) - The price value.
    - **currency** (string) - The currency of the price.

#### Response Example (200)
```json
{
  "orderDisplayId": "123457890",
  "customerName": "Maria",
  "deliveryMan": {
    "email": "Maria@ze.delivery"
  },
  "merchant": {
    "id": "Maria@ze.delivery"
  },
  "deliveryPrice": {
    "price": {
      "value": 10,
      "currency": "BRL"
    }
  }
}
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### Ze Delivery Seller Public API Response Sample (JSON)

Source: https://seller-public-api.ze.delivery/docs

This JSON object represents a sample response from the Ze Delivery Seller Public API, likely containing key performance indicators (KPIs) for a seller. It includes general and turbo-specific metrics like valid orders, fill rates, and delivery accuracy.

```json
{
  "kpis": {
    "general": {
      "validOrders": {
        "type": "INTEGER",
        "value": "26"
      },
      "fillRate": {
        "type": "PERCENTAGE",
        "value": "92.86"
      },
      "promoSellerActivationRate": {
        "type": "PERCENTAGE",
        "value": "4.08"
      },
      "tenMinutesDeliveryReleaseRate": {
        "type": "PERCENTAGE",
        "value": "72.73"
      },
      "deliveryTrackingAccuracyRate": {
        "type": "PERCENTAGE",
        "value": "90.91"
      },
      "thirtyFiveMinutesDeliveryAccurateRate": {
        "type": "PERCENTAGE",
        "value": "90.0"
      },
      "orderRating": {
        "type": "FLOAT",
        "value": "5.0"
      },
      "idealPortfolioRate": {
        "type": "PERCENTAGE",
        "value": "35.37"
      }
    },
    "turbo": {
      "validTurboOrders": {
        "type": "INTEGER",
        "value": "4"
      },
      "turboOrderRating": {
        "type": "FLOAT",
        "value": "5.0"
      },
      "turboFillRate": {
        "type": "PERCENTAGE",
        "value": "100.0"
      },
      "turboTrackingAccuracyRate": {
        "type": "PERCENTAGE",
        "value": "100.0"
      },
      "fiveMinutesTurboDeliveryReleaseRate": {
        "type": "PERCENTAGE",
        "value": "25.0"
      },
      "fifteenMinutesTurboAccurateRate": {
        "type": "PERCENTAGE",
        "value": "75.0"
      }
    },
    "updatedDate": "2026-03-06T18:54:53.887Z"
  }
}
```

--------------------------------

### Create Product Item API Endpoint (cURL)

Source: https://seller-public-api.ze.delivery/docs

This cURL command demonstrates how to send a POST request to the Ze Delivery Seller Public API to create a product item. It includes the merchant ID in the URL and the product details in the JSON request body.

```curl
curl -X POST https://seller-public-api.ze.delivery/merchants/{merchantId}/products/items \
-H "Authorization: Bearer YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{ 
  "productId": "1234",
  "externalProductId": "1234",
  "name": "Nome do Produto",
  "description": "Descrição do produto",
  "category": "categoria",
  "price": {
    "value": 29.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [
    {
      "image": "https://exemplo.com/imagem.jpg",
      "description": "Imagem principal"
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}'
```

--------------------------------

### POST /auth

Source: https://seller-public-api.ze.delivery/docs

Authenticates the client using OAuth2 client_credentials flow to obtain an access token.

```APIDOC
## POST /auth

### Description
Authenticates the client using OAuth2 client_credentials flow to obtain an access token for subsequent API requests.

### Method
POST

### Endpoint
/auth

### Parameters
#### Query Parameters
- **grant_type** (string) - Required - Must be 'client_credentials'.
- **scope** (string) - Required - The requested scope (e.g., 'orders/read').

#### Request Body
- **client_id** (string) - Required - The client identifier.
- **client_secret** (string) - Required - The client secret key.

### Response
#### Success Response (200)
- **access_token** (string) - The OAuth2 access token.
```

--------------------------------

### Product Offer Request Payload (JSON)

Source: https://seller-public-api.ze.delivery/docs

This snippet shows the JSON payload structure for creating or updating a product offer. It includes product identifiers and pricing information. Ensure all required fields are present for a successful request.

```json
{
  "productId": "1234",
  "externalProductId": "1234",
  "price": {
    "value": 29.9,
    "originalValue": 39.9
  }
}
```

--------------------------------

### POST /merchants/{merchantId}/products/items

Source: https://seller-public-api.ze.delivery/docs

Creates a new product item for a specific merchant establishment.

```APIDOC
## POST /merchants/{merchantId}/products/items

### Description
Creates a new product item for a merchant, identified by the merchant ID.

### Method
POST

### Endpoint
/merchants/{merchantId}/products/items

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The unique identifier of the merchant.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token.

#### Request Body
- **externalProductId** (string) - Required - Product ID in the partner system.
- **name** (string) - Required - Product name.
- **description** (string) - Optional - Product description.
- **images** (Array) - Optional - List of product image URLs.
- **price** (object) - Required - Price information (value, originalValue, currency).
- **category** (string) - Optional - Product category slug.
- **tags** (Array) - Optional - List of product tags.

### Request Example
{
  "productId": "1234",
  "externalProductId": "1234",
  "name": "Nome do Produto",
  "description": "Descrição do produto",
  "category": "categoria",
  "price": {
    "value": 29.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [{"image": "https://exemplo.com/imagem.jpg", "description": "Imagem principal"}],
  "tags": ["tag1", "tag2"]
}

### Response
#### Success Response (202)
- **status** (string) - Request accepted for processing.

#### Response Example
{}
```

--------------------------------

### POST /merchants/{merchantId}/products/itemOffer

Source: https://seller-public-api.ze.delivery/docs

This endpoint allows sellers to create or update a product item offer within their merchant account. It requires product identifiers and pricing information.

```APIDOC
## POST /merchants/{merchantId}/products/itemOffer

### Description
Allows sellers to create or update a product item offer. Requires product identifiers and pricing information.

### Method
POST

### Endpoint
/merchants/{merchantId}/products/itemOffer

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The unique identifier for the merchant.

#### Query Parameters
None

#### Request Body
- **productId** (string) - Required - The unique identifier for the product.
- **externalProductId** (string) - Required - The external identifier for the product.
- **price** (object) - Required - Pricing details for the item offer.
  - **value** (number) - Required - The current selling price.
  - **originalValue** (number) - Required - The original or list price.

### Request Example
```json
{
  "productId": "1234",
  "externalProductId": "1234",
  "price": {
    "value": 29.9,
    "originalValue": 39.9
  }
}
```

### Response
#### Success Response (202)
- **message** (string) - Indicates that the request is being processed.

#### Response Example (202)
```json
{ }
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **422** Unprocessable Entity
- **500** Internal Error
```

--------------------------------

### PUT /merchants/products/promos

Source: https://seller-public-api.ze.delivery/docs

Updates product promotions for various establishments. This endpoint allows sellers to manage promotional status for their products.

```APIDOC
## PUT /merchants/products/promos

### Description
Updates product promotions for various establishments. This endpoint allows sellers to manage promotional status for their products.

### Method
PUT

### Endpoint
https://seller-public-api.ze.delivery/merchants/products/promos

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- An array of objects, where each object represents a product promotion update.
  - **isEnabled** (boolean) - Required - Value: true. Indicates if the promotion is enabled.

### Request Example
```json
[
  {
    "isEnabled": true
  }
]
```

### Response
#### Success Response (202)
Request in processing

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden Error
- **404** - Not Found
- **422** - Unprocessable Entity
- **500** - Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```

--------------------------------

### Create Product Item API Request Body (JSON)

Source: https://seller-public-api.ze.delivery/docs

This JSON payload is used to create a new product item for a merchant in the Ze Delivery system. It includes details such as product ID, name, description, category, price, images, and tags.

```json
{
  "productId": "1234",
  "externalProductId": "1234",
  "name": "Nome do Produto",
  "description": "Descrição do produto",
  "category": "categoria",
  "price": {
    "value": 29.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [
    {
      "image": "https://exemplo.com/imagem.jpg",
      "description": "Imagem principal"
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}
```

--------------------------------

### POST /logistics/arrived/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Marks an order as arrived. This endpoint is used to indicate that the delivery person has reached the order's destination.

```APIDOC
## POST /logistics/arrived/{orderNumber}

### Description
Marks an order as arrived. This endpoint is used to indicate that the delivery person has reached the order's destination.

### Method
POST

### Endpoint
/logistics/arrived/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The order number on the Ze Delivery platform. Example: 123456789

#### Request Body
- **email** (string) - Required - The delivery person's email address.

### Request Example
```json
{
  "email": "string"
}
```

### Response
#### Success Response (202)
- **Message**: Requisição em processamento (Request in processing)

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden Error
- **404**: Not Found
- **500**: Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```

--------------------------------

### Update Product Promotions

Source: https://seller-public-api.ze.delivery/docs

Schema for updating product promotion status across multiple establishments. It accepts an array of objects where each object defines the enabled state of a promotion.

```json
[
  {
    "isEnabled": true
  }
]
```

--------------------------------

### POST /logistics/arrivedOrder/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Informs that the order has arrived at its destination. Requires the order number and the delivery person's email.

```APIDOC
## POST /logistics/arrivedOrder/{orderNumber}

### Description
Informs that the order has arrived at its destination. Requires the order number and the delivery person's email.

### Method
POST

### Endpoint
/logistics/arrivedOrder/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The order number on the Ze Delivery platform (minimum 9 characters).

#### Query Parameters
None

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **email** (string) - Required - The email of the delivery person.

### Request Example
```json
{
  "email": "string"
}
```

### Response
#### Success Response (202)
- **message** (string) - Indicates that the request is being processed.

#### Response Example (202)
```json
{ }
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### POST /orders/{orderNumber}/confirm

Source: https://seller-public-api.ze.delivery/docs

Accepts an order by its order number and provides preparation details.

```APIDOC
## POST /orders/{orderNumber}/confirm

### Description
Accepts an order given the order number and provides preparation time and reference codes.

### Method
POST

### Endpoint
/orders/{orderNumber}/confirm

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The unique order ID on the Zé Delivery platform (>= 9 characters).

#### Request Body
- **reason** (string) - Optional - Free text field for confirmation information.
- **orderExternalCode** (string) - Optional - External reference code for the order.
- **createdAt** (string) - Optional - Date and time of order creation.
- **preparationTime** (number) - Optional - Estimated preparation time in minutes.

### Request Example
{
  "reason": "string",
  "orderExternalCode": "string",
  "createdAt": "2021-09-15T19:51:57.851343",
  "preparationTime": 0
}

### Response
#### Success Response (202)
- **status** (string) - Request accepted for processing.

#### Error Response (400/401/403/404/500)
- **code** (string) - Error code
- **title** (string) - Error title
- **messages** (array) - List of error messages
```

--------------------------------

### Create or Update Product Item

Source: https://seller-public-api.ze.delivery/docs

Defines the JSON schema for creating or updating a single product item within a specific merchant's catalog. It includes fields for product identification, pricing, categorization, and image metadata.

```json
{
  "productId": "1234",
  "externalProductId": "1234",
  "name": "Nome do Produto",
  "description": "Descrição do produto",
  "category": "categoria",
  "price": {
    "value": 29.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [
    {
      "image": "https://exemplo.com/imagem.jpg",
      "description": "Imagem principal",
      "order": 1
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}
```

--------------------------------

### PUT /merchants/{merchantId}/products/items

Source: https://seller-public-api.ze.delivery/docs

Updates or creates product items for a merchant. This endpoint allows for the modification or addition of product details, including pricing, images, and tags.

```APIDOC
## PUT /merchants/{merchantId}/products/items

### Description
Updates or creates product items for a merchant. This endpoint allows for the modification or addition of product details, including pricing, images, and tags.

### Method
PUT

### Endpoint
https://seller-public-api.ze.delivery/merchants/{merchantId}/products/items

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the merchant.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **productId** (integer) - Optional - The identifier of the product on the Zé Delivery platform.
- **externalProductId** (string) - Optional - The identifier of the product in the source system (partner platform).
- **name** (string) - Required - The name of the product.
- **description** (string) - Required - The description of the product.
- **images** (Array of objects) - Optional - A list of URLs for product images.
  - **image** (string) - The image URL.
  - **description** (string) - The image description.
  - **order** (integer) - The order of the image.
- **price** (object) - Optional - Product pricing information.
  - **value** (number) - The current price of the product.
  - **originalValue** (number) - The original price of the product (used for discounts).
  - **currency** (string) - The currency of the price (e.g., 'BRL').
- **category** (string) - Required - The code or slug of the product category in the catalog.
- **tags** (Array of strings) - Optional - Tags associated with the product.

### Request Example
```json
{
  "productId": "1234",
  "externalProductId": "1234",
  "name": "Nome do Produto",
  "description": "Descrição do produto",
  "category": "categoria",
  "price": {
    "value": 29.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [
    {
      "image": "https://exemplo.com/imagem.jpg",
      "description": "Imagem principal",
      "order": 1
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ]
}
```

### Response
#### Success Response (202)
Request in processing

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden Error
- **404** - Not Found
- **422** - Unprocessable Entity
- **500** - Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```

--------------------------------

### PUT /merchants/products/items

Source: https://seller-public-api.ze.delivery/docs

Upserts a list of product items for multiple merchants. This endpoint is used to update or create multiple product items efficiently.

```APIDOC
## PUT /merchants/products/items

### Description
Upserts a list of product items for multiple merchants. This endpoint is used to update or create multiple product items efficiently.

### Method
PUT

### Endpoint
https://seller-public-api.ze.delivery/merchants/products/items

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **items** (Array of objects) - Required - A list of product items to upsert.
  - **merchantId** (string) - Required - The ID of the merchant.
  - **productId** (string) - Required - The identifier of the product on the Zé Delivery platform.
  - **externalProductId** (string) - Required - The identifier of the product in the source system (partner platform).
  - **isAvailable** (boolean) - Required - Indicates if the product is available.
  - **isFavorite** (boolean) - Required - Indicates if the product is a favorite.

### Request Example
```json
{
  "items": [
    {
      "merchantId": "string",
      "productId": "string",
      "externalProductId": "string",
      "isAvailable": true,
      "isFavorite": true
    }
  ]
}
```

### Response
#### Success Response (202)
Request in processing

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden Error
- **422** - Unprocessable Entity
- **500** - Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```

--------------------------------

### Bulk Upsert Product Items

Source: https://seller-public-api.ze.delivery/docs

Schema for performing a bulk upsert operation on product items. It accepts an array of items containing merchant and product identifiers along with availability and favorite status flags.

```json
{
  "items": [
    {
      "merchantId": "string",
      "productId": "string",
      "externalProductId": "string",
      "isAvailable": true,
      "isFavorite": true
    }
  ]
}
```

--------------------------------

### Retrieve Merchant Information

Source: https://seller-public-api.ze.delivery/docs

Fetches detailed information about a specific merchant, including current status and portfolio metrics. Requires a merchant ID and authorization token.

```json
{
  "status": "AVAILABLE",
  "basicInfo": {
    "idealPortfolio": {
      "totalProducts": 0,
      "totalActiveProducts": 0,
      "activeProductsPercentage": 0
    }
  }
}
```

--------------------------------

### Update Order Items via PUT request

Source: https://seller-public-api.ze.delivery/docs

Updates items in a confirmed order by removing or replacing specific products. Requires a valid authorization token and at least one of the removedItems or replacedItems arrays.

```json
{
  "removedItems": [
    {
      "productId": "12345",
      "externalProductId": "ext-12345",
      "quantity": 2
    }
  ],
  "replacedItems": [
    {
      "currentItem": {
        "productId": "12345",
        "externalProductId": "ext-12345",
        "quantity": 2
      },
      "newItem": {
        "productId": "12345",
        "externalProductId": "ext-12345",
        "quantity": 2
      }
    }
  ]
}
```

--------------------------------

### POST /merchants/{merchantId}/products/availability

Source: https://seller-public-api.ze.delivery/docs

Updates the availability status of a product for a specific merchant. This endpoint allows sellers to control whether a product is available for purchase on Zé Delivery.

```APIDOC
## POST /merchants/{merchantId}/products/availability

### Description
Updates the availability status of a product for a specific merchant. This endpoint allows sellers to control whether a product is available for purchase on Zé Delivery.

### Method
POST

### Endpoint
`/merchants/{merchantId}/products/availability`

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the merchant.

#### Request Body
- **productId** (integer) - Required - The identifier of the product on the Zé Delivery platform.
- **externalProductId** (string) - Required - The identifier of the product on a third-party platform.
- **available** (boolean) - Required - The availability status of the product.

### Request Example
```json
{
  "productId": 1234,
  "externalProductId": "1234",
  "available": true
}
```

### Response
#### Success Response (200)
OK

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **422** Unprocessable Entity
- **500** Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```

--------------------------------

### Update Product Item API Endpoint (cURL)

Source: https://seller-public-api.ze.delivery/docs

This cURL command illustrates how to send a PUT request to the Ze Delivery Seller Public API to update an existing product item. It requires the merchant ID in the URL and the updated product details in the request body.

```curl
curl -X PUT https://seller-public-api.ze.delivery/merchants/{merchantId}/products/items/{productId} \
-H "Authorization: Bearer YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{ 
  "externalProductId": "1234",
  "name": "Nome do Produto Atualizado",
  "description": "Descrição do produto atualizada",
  "category": "categoria",
  "price": {
    "value": 25.9,
    "originalValue": 39.9,
    "currency": "BRL"
  },
  "images": [
    {
      "image": "https://exemplo.com/imagem_atualizada.jpg",
      "description": "Imagem principal atualizada"
    }
  ],
  "tags": [
    "tag1",
    "tag3"
  ]
}'
```

--------------------------------

### POST /logistics/orderPicked/{orderNumber}

Source: https://seller-public-api.ze.delivery/docs

Informs that the delivery person has picked up the order. Requires the order number and the delivery person's email.

```APIDOC
## POST /logistics/orderPicked/{orderNumber}

### Description
Informs that the delivery person has picked up the order. Requires the order number and the delivery person's email.

### Method
POST

### Endpoint
/logistics/orderPicked/{orderNumber}

### Parameters
#### Path Parameters
- **orderNumber** (string) - Required - The order number on the Ze Delivery platform (minimum 9 characters).

#### Query Parameters
None

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **email** (string) - Required - The email of the delivery person.

### Request Example
```json
{
  "email": "string"
}
```

### Response
#### Success Response (202)
- **message** (string) - Indicates that the request is being processed.

#### Response Example (202)
```json
{ }
```

#### Error Responses
- **400** Bad Request
- **401** Unauthorized
- **403** Forbidden Error
- **404** Not Found
- **500** Internal Error
```

--------------------------------

### Confirm Order Request

Source: https://seller-public-api.ze.delivery/docs

Schema for the request body required to confirm an order. It includes the preparation time and optional external reference codes.

```json
{
  "reason": "string",
  "orderExternalCode": "string",
  "createdAt": "2021-09-15T19:51:57.851343",
  "preparationTime": 0
}
```

--------------------------------

### Order Data Structure

Source: https://seller-public-api.ze.delivery/docs

Represents the JSON schema for an order object returned by the API, containing customer information, delivery details, items, and payment status.

```json
{
  "displayId": "123457890",
  "status": "CREATED",
  "type": "DELIVERY",
  "createdAt": "2021-09-15T19:51:57.851343",
  "merchant": { "id": 12345 },
  "items": [
    {
      "id": 12345,
      "name": "Refrigerante de Limão 2L",
      "quantity": 1,
      "unitPrice": { "value": "10.00", "currency": "BRL" }
    }
  ],
  "total": { "orderAmount": { "value": "10.00", "currency": "BRL" } }
}
```

--------------------------------

### PUT /merchants/{merchantId}/products/items/{productId}/availability

Source: https://seller-public-api.ze.delivery/docs

Updates the availability of a specific product for a given merchant. This endpoint allows sellers to control whether a product is available for purchase.

```APIDOC
## PUT /merchants/{merchantId}/products/items/{productId}/availability

### Description
Updates the availability of a specific product for a given merchant. This endpoint allows sellers to control whether a product is available for purchase.

### Method
PUT

### Endpoint
https://seller-public-api.ze.delivery/merchants/{merchantId}/products/items/{productId}/availability

### Parameters
#### Path Parameters
- **merchantId** (string) - Required - The ID of the merchant.
- **productId** (string) - Required - The identifier of the product on the Zé Delivery platform.

#### Header Parameters
- **Authorization** (string) - Required - Authentication token to access the resource.

#### Request Body
- **isAvailable** (boolean) - Required - Indicates if the product is available.

### Request Example
```json
{
  "isAvailable": true
}
```

### Response
#### Success Response (202)
Request in processing

#### Error Responses
- **400** - Bad Request
- **401** - Unauthorized
- **403** - Forbidden Error
- **404** - Not Found
- **422** - Unprocessable Entity
- **500** - Internal Error

#### Response Example (Error)
```json
{
  "code": "string",
  "title": "string",
  "type": "string",
  "messages": [
    "string"
  ]
}
```
```
Tokens:
Raw