find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/orderful-delivery-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Orderful Delivery API
  description: The official Orderful API documentation.
  version: 2.15.0
  contact:
    name: Orderful
    url: https://orderful.com
    email: developers@orderful.com
  termsOfService: https://orderful.com/terms-and-conditions/
servers:
- url: https://api.orderful.com
tags:
- name: Delivery
  description: Approve or fail transaction deliveries.
paths:
  /v3/deliveries/{deliveryId}/approve:
    post:
      operationId: DeliveryController_handleDeliveryApproved
      summary: Approve a Delivery
      description: 'Approves the specified Delivery. This link is included when a Transaction is retrieved from a Poller Bucket or via an Inbound HTTP Communication Channel.


        If this Delivery is the most recent one associated with a Transaction, this will update the Transaction''s `deliveryStatus` to `DELIVERED`.


        If this Delivery is associated with one or more Transactions in a Poller Bucket, this will also remove the Transactions from that Bucket.'
      parameters:
      - name: deliveryId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveDeliveryRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - Delivery
      security:
      - API_KEY: []
  /v3/deliveries/{deliveryId}/fail:
    post:
      operationId: DeliveryController_handleFailDeliveryRequest
      summary: Fail a Delivery
      description: 'Fails the specified Delivery. This link is included when a Transaction is retrieved from a Poller Bucket or via an Inbound HTTP Communication Channel.


        If this Delivery is the most recent one associated with a Transaction, this will update the Transaction''s `deliveryStatus` to `FAILED`.


        If this Delivery is associated with one or more Transactions in a Poller Bucket, this will also remove the Transactions from that Bucket.'
      parameters:
      - name: deliveryId
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FailDeliveryRequestDto'
      responses:
        '200':
          description: ''
      tags:
      - Delivery
      security:
      - API_KEY: []
components:
  schemas:
    FailDeliveryRequestDto:
      type: object
      properties:
        note:
          type: string
    ApproveDeliveryRequestDto:
      type: object
      properties:
        note:
          type: string
  securitySchemes:
    API_KEY:
      type: apiKey
      in: header
      name: orderful-api-key