Abrasel-Nacional / docs

https://abrasel-nacional.github.io/docs/
Apache License 2.0
11 stars 4 forks source link

Open Delivery API Specification

The present repository defines the OpenAPI 3.0.3 functional specifications for the Open Delivery API.

Introduction

Open Delivery proposes to solve the challenge of organizing the flow of information between merchants and Ordering Applications, establishing a single communication standard for all, through a set of REST APIs. Thus, menus and orders are standardized and customer requests are received in a single place, in an organized and efficient way, allowing the merchant to work with more partners in the delivery environment.

Versions

RELEASE VERSIONS

Contains the specifications of the standards already published:
MERCHANT | ORDERS | LOGISTICS

LATEST RELEASE - v1.4.0

All Versions:

*Release Candidate versions contains the evolutions and improvements being discussed at the moment and that will be part of the release version in the future.

BETA

Contains the standards still in tests:
FINANCIAL RECONCILIATION | CONTRACTS

Changelog

See the Latest Changes here.

Issues and Suggestions

In case of doubts, suggestions, improvements, problems or any information regarding the documentation presented here, feel free to open a new issue.

Developer Tools

This section has some tools to help you implement the Open Delivery API.

Disclaimer: The tools listed below are tools made available by partners of the Open Delivery project and are the sole responsibility of their authors. The Open Delivery does not provide support for these tools.

SCHEMA VALIDATORS

Open Delivery - API Schema Validator (by Programmers IT) Tool for comparing a JSON file with Open Delivery schemas.

MERCHANT RELATED TOOLS

Open Delivery - Menu Generator (by Programmers IT)
Tool for graphical visualization of the different fields and entities that compose the Merchant object.

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.