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/asendia:asendia-idmailinterface-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: Asendia ID Mail Interface API
  version: IDMailInterface
  contact:
    name: Asendia USA Web Service Team for any questions or comments.
    email: john.mcshane@asendia.com;chris.joiner@asendia.com;katie.vogt@asendia.com;ammi.cabrera@asendia.com
  description: 'Operations tagged IDMailInterface across 2 of this provider''s published API definitions: asendia-a1-idmailinterface-swagger.json, asendia-a1-idmailinterface-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: IDMailInterface
paths:
  /api/A1/External/IDMailInterface/InsertProcessingEntry:
    post:
      tags:
      - IDMailInterface
      requestBody:
        content:
          application/json-patch+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InsertProcessingEntryRequest'
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InsertProcessingEntryRequest'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InsertProcessingEntryRequest'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/InsertProcessingEntryRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
      summary: Create api a1 external id mail interface insert processing entry
      x-summary-source: derived
      operationId: postApiA1ExternalIDMailInterfaceInsertProcessingEntry
      x-operation-id-source: derived
  /api/A1/External/IDMailInterface/CloseBag:
    put:
      tags:
      - IDMailInterface
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CloseBagRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CloseBagRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CloseBagRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CloseBagRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
      summary: Replace api a1 external id mail interface close bag
      x-summary-source: derived
      operationId: putApiA1ExternalIDMailInterfaceCloseBag
      x-operation-id-source: derived
  /api/A1/External/IDMailInterface/FinishRun:
    put:
      tags:
      - IDMailInterface
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/FinishRunRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/FinishRunRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FinishRunRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FinishRunRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Int32ApiResponse'
      summary: Replace api a1 external id mail interface finish run
      x-summary-source: derived
      operationId: putApiA1ExternalIDMailInterfaceFinishRun
      x-operation-id-source: derived
components:
  schemas:
    FinishRunRequest:
      required:
      - dispatcher
      - jobId
      - processingLocation
      type: object
      properties:
        jobId:
          maxLength: 30
          type: string
        dispatcher:
          maxLength: 20
          type: string
        processingLocation:
          maxLength: 3
          minLength: 3
          type: string
          description: 'The Asendia''s location in where the mail is processed.

            Possible values: SFO, MIA, JFK, PHL, ORD, LAX, SLC, TOR, CAL'
      additionalProperties: false
    InsertProcessingEntryRequest:
      required:
      - bagId
      - bin
      - custom1
      - height
      - indicia
      - jobId
      - length
      - machineID
      - mailStop
      - pieceId
      - processingLocation
      - size
      - sortCode
      - thickness
      - weight
      - worldWare
      - zone
      type: object
      properties:
        jobId:
          maxLength: 30
          type: string
        bagId:
          maxLength: 20
          type: string
        pieceId:
          maxLength: 20
          type: string
        bin:
          maxLength: 20
          type: string
        mailStop:
          maxLength: 50
          type: string
        sortCode:
          maxLength: 11
          type: string
        weight:
          minimum: 0
          type: number
          format: double
        height:
          minimum: 0
          type: number
          format: double
        length:
          minimum: 0
          type: number
          format: double
        thickness:
          minimum: 0
          type: number
          format: double
        size:
          maxLength: 2
          type: string
        custom1:
          maxLength: 40
          type: string
        zone:
          maxLength: 3
          type: string
        indicia:
          maxLength: 10
          type: string
        machineID:
          maxLength: 20
          type: string
        worldWare:
          maxLength: 20
          type: string
        processingLocation:
          maxLength: 3
          minLength: 3
          type: string
          description: 'The Asendia''s location in where the mail is processed.

            Possible values: SFO, MIA, JFK, PHL, ORD, LAX, SLC, TOR, CAL'
      additionalProperties: false
    CloseBagRequest:
      required:
      - bagId
      - dispatcher
      - processingLocation
      - zone
      type: object
      properties:
        bagId:
          maxLength: 20
          type: string
        zone:
          maxLength: 3
          type: string
        dispatcher:
          maxLength: 20
          type: string
        processingLocation:
          maxLength: 3
          minLength: 3
          type: string
          description: 'The Asendia''s location in where the mail is processed.

            Possible values: SFO, MIA, JFK, PHL, ORD, LAX, SLC, TOR, CAL'
      additionalProperties: false
    Int32ApiResponse:
      type: object
      properties:
        data:
          type: integer
          format: int32
        responseStatus:
          allOf:
          - $ref: '#/components/schemas/ResponseStatus'
      additionalProperties: false
    ResponseStatus:
      type: object
      properties:
        responseStatusCode:
          type: integer
          description: This is used to display the code for the return status.
          format: int32
        responseStatusMessage:
          type:
          - string
          - 'null'
          description: This is used for a human readable return status message.
      additionalProperties: false
      description: Displays the status of the Return
x-refined-from:
- asendia-a1-idmailinterface-swagger.json
- asendia-a1-idmailinterface-openapi.yml
x-provenance:
  method: harvested
  publisher: Asendia
  source: https://a1api.asendiausa.com/swagger/IDMailInterface/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)